From dc7ac74c1d2c97544056541736d644060837a080 Mon Sep 17 00:00:00 2001 From: Miguel Grinberg Date: Sat, 25 Jun 2022 12:51:02 +0100 Subject: [PATCH] Update Django example --- examples/server/wsgi/README.rst | 4 +- .../django_example/django_example/urls.py | 22 ---------- examples/server/wsgi/django_example/manage.py | 23 ---------- .../wsgi/django_example/requirements.txt | 8 ---- .../management/commands/__init__.py | 0 .../management/commands/runserver.py | 39 ---------------- .../socketio_app/migrations/__init__.py | 0 .../wsgi/django_example/socketio_app/urls.py | 7 --- .../server/wsgi/django_socketio/README.md | 16 +++++++ .../django_socketio}/__init__.py | 0 .../django_socketio/django_socketio/asgi.py | 16 +++++++ .../django_socketio}/settings.py | 44 ++++++++++--------- .../django_socketio/django_socketio/urls.py | 23 ++++++++++ .../django_socketio}/wsgi.py | 6 +-- .../server/wsgi/django_socketio/manage.py | 22 ++++++++++ .../wsgi/django_socketio/requirements.txt | 7 +++ .../socketio_app/__init__.py | 0 .../socketio_app/admin.py | 1 - .../socketio_app/apps.py | 1 + .../socketio_app/migrations}/__init__.py | 0 .../socketio_app/models.py | 1 - .../socketio_app/static/index.html | 0 .../socketio_app/tests.py | 1 - .../wsgi/django_socketio/socketio_app/urls.py | 7 +++ .../socketio_app/views.py | 0 tox.ini | 2 +- 26 files changed, 121 insertions(+), 129 deletions(-) delete mode 100644 examples/server/wsgi/django_example/django_example/urls.py delete mode 100755 examples/server/wsgi/django_example/manage.py delete mode 100644 examples/server/wsgi/django_example/requirements.txt delete mode 100644 examples/server/wsgi/django_example/socketio_app/management/commands/__init__.py delete mode 100644 examples/server/wsgi/django_example/socketio_app/management/commands/runserver.py delete mode 100644 examples/server/wsgi/django_example/socketio_app/migrations/__init__.py delete mode 100644 examples/server/wsgi/django_example/socketio_app/urls.py create mode 100644 examples/server/wsgi/django_socketio/README.md rename examples/server/wsgi/{django_example/django_example => django_socketio/django_socketio}/__init__.py (100%) create mode 100644 examples/server/wsgi/django_socketio/django_socketio/asgi.py rename examples/server/wsgi/{django_example/django_example => django_socketio/django_socketio}/settings.py (67%) create mode 100644 examples/server/wsgi/django_socketio/django_socketio/urls.py rename examples/server/wsgi/{django_example/django_example => django_socketio/django_socketio}/wsgi.py (64%) create mode 100755 examples/server/wsgi/django_socketio/manage.py create mode 100644 examples/server/wsgi/django_socketio/requirements.txt rename examples/server/wsgi/{django_example => django_socketio}/socketio_app/__init__.py (100%) rename examples/server/wsgi/{django_example => django_socketio}/socketio_app/admin.py (80%) rename examples/server/wsgi/{django_example => django_socketio}/socketio_app/apps.py (63%) rename examples/server/wsgi/{django_example/socketio_app/management => django_socketio/socketio_app/migrations}/__init__.py (100%) rename examples/server/wsgi/{django_example => django_socketio}/socketio_app/models.py (79%) rename examples/server/wsgi/{django_example => django_socketio}/socketio_app/static/index.html (100%) rename examples/server/wsgi/{django_example => django_socketio}/socketio_app/tests.py (80%) create mode 100644 examples/server/wsgi/django_socketio/socketio_app/urls.py rename examples/server/wsgi/{django_example => django_socketio}/socketio_app/views.py (100%) diff --git a/examples/server/wsgi/README.rst b/examples/server/wsgi/README.rst index bedfbbe..72806b6 100644 --- a/examples/server/wsgi/README.rst +++ b/examples/server/wsgi/README.rst @@ -24,8 +24,8 @@ time to the page. This is an ideal application to measure the performance of the different asynchronous modes supported by the Socket.IO server. -django_example --------------- +django_socketio +--------------- This is a version of the "app.py" application described above, that is based on the Django web framework. diff --git a/examples/server/wsgi/django_example/django_example/urls.py b/examples/server/wsgi/django_example/django_example/urls.py deleted file mode 100644 index 5af870f..0000000 --- a/examples/server/wsgi/django_example/django_example/urls.py +++ /dev/null @@ -1,22 +0,0 @@ -"""django_example URL Configuration - -The `urlpatterns` list routes URLs to views. For more information please see: - https://docs.djangoproject.com/en/1.11/topics/http/urls/ -Examples: -Function views - 1. Add an import: from my_app import views - 2. Add a URL to urlpatterns: url(r'^$', views.home, name='home') -Class-based views - 1. Add an import: from other_app.views import Home - 2. Add a URL to urlpatterns: url(r'^$', Home.as_view(), name='home') -Including another URLconf - 1. Import the include() function: from django.conf.urls import url, include - 2. Add a URL to urlpatterns: url(r'^blog/', include('blog.urls')) -""" -from django.conf.urls import url, include -from django.contrib import admin - -urlpatterns = [ - url(r'', include('socketio_app.urls')), - url(r'^admin/', admin.site.urls), -] diff --git a/examples/server/wsgi/django_example/manage.py b/examples/server/wsgi/django_example/manage.py deleted file mode 100755 index 3c56a79..0000000 --- a/examples/server/wsgi/django_example/manage.py +++ /dev/null @@ -1,23 +0,0 @@ -#!/usr/bin/env python -# flake8: noqa -import os -import sys - -if __name__ == "__main__": - os.environ.setdefault("DJANGO_SETTINGS_MODULE", "django_example.settings") - try: - from django.core.management import execute_from_command_line - except ImportError: - # The above import may fail for some other reason. Ensure that the - # issue is really that Django is missing to avoid masking other - # exceptions on Python 2. - try: - import django # pragma: F401 - except ImportError: - raise ImportError( - "Couldn't import Django. Are you sure it's installed and " - "available on your PYTHONPATH environment variable? Did you " - "forget to activate a virtual environment?" - ) - raise - execute_from_command_line(sys.argv) diff --git a/examples/server/wsgi/django_example/requirements.txt b/examples/server/wsgi/django_example/requirements.txt deleted file mode 100644 index 108517d..0000000 --- a/examples/server/wsgi/django_example/requirements.txt +++ /dev/null @@ -1,8 +0,0 @@ -django==2.2.13 -enum-compat==0.0.3 -eventlet==0.30.0 -greenlet==0.4.17 -python-engineio -python-socketio -pytz==2018.7 -six==1.10.0 diff --git a/examples/server/wsgi/django_example/socketio_app/management/commands/__init__.py b/examples/server/wsgi/django_example/socketio_app/management/commands/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/examples/server/wsgi/django_example/socketio_app/management/commands/runserver.py b/examples/server/wsgi/django_example/socketio_app/management/commands/runserver.py deleted file mode 100644 index 69bd6b4..0000000 --- a/examples/server/wsgi/django_example/socketio_app/management/commands/runserver.py +++ /dev/null @@ -1,39 +0,0 @@ -from django.core.management.commands.runserver import Command as RunCommand - -from socketio_app.views import sio - - -class Command(RunCommand): - help = 'Run the Socket.IO server' - - def handle(self, *args, **options): - if sio.async_mode == 'threading': - super(Command, self).handle(*args, **options) - elif sio.async_mode == 'eventlet': - # deploy with eventlet - import eventlet - import eventlet.wsgi - from django_example.wsgi import application - eventlet.wsgi.server(eventlet.listen(('', 8000)), application) - elif sio.async_mode == 'gevent': - # deploy with gevent - from gevent import pywsgi - from django_example.wsgi import application - try: - from geventwebsocket.handler import WebSocketHandler - websocket = True - except ImportError: - websocket = False - if websocket: - pywsgi.WSGIServer( - ('', 8000), application, - handler_class=WebSocketHandler).serve_forever() - else: - pywsgi.WSGIServer(('', 8000), application).serve_forever() - elif sio.async_mode == 'gevent_uwsgi': - print('Start the application through the uwsgi server. Example:') - print('uwsgi --http :5000 --gevent 1000 --http-websockets ' - '--master --wsgi-file django_example/wsgi.py --callable ' - 'application') - else: - print('Unknown async_mode: ' + sio.async_mode) diff --git a/examples/server/wsgi/django_example/socketio_app/migrations/__init__.py b/examples/server/wsgi/django_example/socketio_app/migrations/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/examples/server/wsgi/django_example/socketio_app/urls.py b/examples/server/wsgi/django_example/socketio_app/urls.py deleted file mode 100644 index e0409c0..0000000 --- a/examples/server/wsgi/django_example/socketio_app/urls.py +++ /dev/null @@ -1,7 +0,0 @@ -from django.conf.urls import url - -from . import views - -urlpatterns = [ - url(r'', views.index, name='index'), -] diff --git a/examples/server/wsgi/django_socketio/README.md b/examples/server/wsgi/django_socketio/README.md new file mode 100644 index 0000000..9fcbabe --- /dev/null +++ b/examples/server/wsgi/django_socketio/README.md @@ -0,0 +1,16 @@ +django-socketio +=============== + +This is an example Django application integrated with Socket.IO. + +You can run it with the Django development web server: + +```bash +python manage.py runserver +``` + +When running in this mode, you will see a warning indicating that the WebSocket +transport is not available, which is not supported by this web server. + +See the documentation for information on supported deployment methods that you +can use to add support for WebSocket. diff --git a/examples/server/wsgi/django_example/django_example/__init__.py b/examples/server/wsgi/django_socketio/django_socketio/__init__.py similarity index 100% rename from examples/server/wsgi/django_example/django_example/__init__.py rename to examples/server/wsgi/django_socketio/django_socketio/__init__.py diff --git a/examples/server/wsgi/django_socketio/django_socketio/asgi.py b/examples/server/wsgi/django_socketio/django_socketio/asgi.py new file mode 100644 index 0000000..234d2d9 --- /dev/null +++ b/examples/server/wsgi/django_socketio/django_socketio/asgi.py @@ -0,0 +1,16 @@ +""" +ASGI config for django_socketio project. + +It exposes the ASGI callable as a module-level variable named ``application``. + +For more information on this file, see +https://docs.djangoproject.com/en/4.0/howto/deployment/asgi/ +""" + +import os + +from django.core.asgi import get_asgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'django_socketio.settings') + +application = get_asgi_application() diff --git a/examples/server/wsgi/django_example/django_example/settings.py b/examples/server/wsgi/django_socketio/django_socketio/settings.py similarity index 67% rename from examples/server/wsgi/django_example/django_example/settings.py rename to examples/server/wsgi/django_socketio/django_socketio/settings.py index 9dd3c6c..313462d 100644 --- a/examples/server/wsgi/django_example/django_example/settings.py +++ b/examples/server/wsgi/django_socketio/django_socketio/settings.py @@ -1,27 +1,26 @@ -# flake8: noqa """ -Django settings for django_example project. +Django settings for django_socketio project. -Generated by 'django-admin startproject' using Django 1.11.1. +Generated by 'django-admin startproject' using Django 4.0.5. For more information on this file, see -https://docs.djangoproject.com/en/1.11/topics/settings/ +https://docs.djangoproject.com/en/4.0/topics/settings/ For the full list of settings and their values, see -https://docs.djangoproject.com/en/1.11/ref/settings/ +https://docs.djangoproject.com/en/4.0/ref/settings/ """ -import os +from pathlib import Path -# Build paths inside the project like this: os.path.join(BASE_DIR, ...) -BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) +# Build paths inside the project like this: BASE_DIR / 'subdir'. +BASE_DIR = Path(__file__).resolve().parent.parent # Quick-start development settings - unsuitable for production -# See https://docs.djangoproject.com/en/1.11/howto/deployment/checklist/ +# See https://docs.djangoproject.com/en/4.0/howto/deployment/checklist/ # SECURITY WARNING: keep the secret key used in production secret! -SECRET_KEY = '+vk#7#92ncb*y)8^$7sd&99%^+xc+t)nmamacbp8^vgjy(&g-9' +SECRET_KEY = 'django-insecure-&@-nkbrpe@%1_%ljh#oe@sw)6+k(&yn#r_)!5p)$22c^u#0@lj' # SECURITY WARNING: don't run with debug turned on in production! DEBUG = True @@ -32,13 +31,13 @@ ALLOWED_HOSTS = [] # Application definition INSTALLED_APPS = [ - 'socketio_app', 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', + 'socketio_app', ] MIDDLEWARE = [ @@ -51,7 +50,7 @@ MIDDLEWARE = [ 'django.middleware.clickjacking.XFrameOptionsMiddleware', ] -ROOT_URLCONF = 'django_example.urls' +ROOT_URLCONF = 'django_socketio.urls' TEMPLATES = [ { @@ -69,22 +68,22 @@ TEMPLATES = [ }, ] -WSGI_APPLICATION = 'django_example.wsgi.application' +WSGI_APPLICATION = 'django_socketio.wsgi.application' # Database -# https://docs.djangoproject.com/en/1.11/ref/settings/#databases +# https://docs.djangoproject.com/en/4.0/ref/settings/#databases DATABASES = { 'default': { 'ENGINE': 'django.db.backends.sqlite3', - 'NAME': os.path.join(BASE_DIR, 'db.sqlite3'), + 'NAME': BASE_DIR / 'db.sqlite3', } } # Password validation -# https://docs.djangoproject.com/en/1.11/ref/settings/#auth-password-validators +# https://docs.djangoproject.com/en/4.0/ref/settings/#auth-password-validators AUTH_PASSWORD_VALIDATORS = [ { @@ -103,7 +102,7 @@ AUTH_PASSWORD_VALIDATORS = [ # Internationalization -# https://docs.djangoproject.com/en/1.11/topics/i18n/ +# https://docs.djangoproject.com/en/4.0/topics/i18n/ LANGUAGE_CODE = 'en-us' @@ -111,12 +110,15 @@ TIME_ZONE = 'UTC' USE_I18N = True -USE_L10N = True - USE_TZ = True # Static files (CSS, JavaScript, Images) -# https://docs.djangoproject.com/en/1.11/howto/static-files/ +# https://docs.djangoproject.com/en/4.0/howto/static-files/ + +STATIC_URL = 'static/' + +# Default primary key field type +# https://docs.djangoproject.com/en/4.0/ref/settings/#default-auto-field -STATIC_URL = '/static/' +DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField' diff --git a/examples/server/wsgi/django_socketio/django_socketio/urls.py b/examples/server/wsgi/django_socketio/django_socketio/urls.py new file mode 100644 index 0000000..c156551 --- /dev/null +++ b/examples/server/wsgi/django_socketio/django_socketio/urls.py @@ -0,0 +1,23 @@ +"""django_socketio URL Configuration + +The `urlpatterns` list routes URLs to views. For more information please see: + https://docs.djangoproject.com/en/4.0/topics/http/urls/ +Examples: +Function views + 1. Add an import: from my_app import views + 2. Add a URL to urlpatterns: path('', views.home, name='home') +Class-based views + 1. Add an import: from other_app.views import Home + 2. Add a URL to urlpatterns: path('', Home.as_view(), name='home') +Including another URLconf + 1. Import the include() function: from django.urls import include, path + 2. Add a URL to urlpatterns: path('blog/', include('blog.urls')) +""" +from django.contrib import admin +from django.urls import path +from django.conf.urls import include + +urlpatterns = [ + path('admin/', admin.site.urls), + path(r'', include('socketio_app.urls')), +] diff --git a/examples/server/wsgi/django_example/django_example/wsgi.py b/examples/server/wsgi/django_socketio/django_socketio/wsgi.py similarity index 64% rename from examples/server/wsgi/django_example/django_example/wsgi.py rename to examples/server/wsgi/django_socketio/django_socketio/wsgi.py index 0f25a70..771cae2 100644 --- a/examples/server/wsgi/django_example/django_example/wsgi.py +++ b/examples/server/wsgi/django_socketio/django_socketio/wsgi.py @@ -1,10 +1,10 @@ """ -WSGI config for django_example project. +WSGI config for django_socketio project. It exposes the WSGI callable as a module-level variable named ``application``. For more information on this file, see -https://docs.djangoproject.com/en/1.11/howto/deployment/wsgi/ +https://docs.djangoproject.com/en/4.0/howto/deployment/wsgi/ """ import os @@ -14,7 +14,7 @@ import socketio from socketio_app.views import sio -os.environ.setdefault("DJANGO_SETTINGS_MODULE", "django_example.settings") +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'django_socketio.settings') django_app = get_wsgi_application() application = socketio.WSGIApp(sio, django_app) diff --git a/examples/server/wsgi/django_socketio/manage.py b/examples/server/wsgi/django_socketio/manage.py new file mode 100755 index 0000000..35ef79b --- /dev/null +++ b/examples/server/wsgi/django_socketio/manage.py @@ -0,0 +1,22 @@ +#!/usr/bin/env python +"""Django's command-line utility for administrative tasks.""" +import os +import sys + + +def main(): + """Run administrative tasks.""" + os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'django_socketio.settings') + try: + from django.core.management import execute_from_command_line + except ImportError as exc: + raise ImportError( + "Couldn't import Django. Are you sure it's installed and " + "available on your PYTHONPATH environment variable? Did you " + "forget to activate a virtual environment?" + ) from exc + execute_from_command_line(sys.argv) + + +if __name__ == '__main__': + main() diff --git a/examples/server/wsgi/django_socketio/requirements.txt b/examples/server/wsgi/django_socketio/requirements.txt new file mode 100644 index 0000000..fb7c61c --- /dev/null +++ b/examples/server/wsgi/django_socketio/requirements.txt @@ -0,0 +1,7 @@ +asgiref==3.5.2 +backports.zoneinfo==0.2.1 +bidict==0.22.0 +Django==4.0.5 +python-engineio==4.3.2 +python-socketio==5.6.0 +sqlparse==0.4.2 diff --git a/examples/server/wsgi/django_example/socketio_app/__init__.py b/examples/server/wsgi/django_socketio/socketio_app/__init__.py similarity index 100% rename from examples/server/wsgi/django_example/socketio_app/__init__.py rename to examples/server/wsgi/django_socketio/socketio_app/__init__.py diff --git a/examples/server/wsgi/django_example/socketio_app/admin.py b/examples/server/wsgi/django_socketio/socketio_app/admin.py similarity index 80% rename from examples/server/wsgi/django_example/socketio_app/admin.py rename to examples/server/wsgi/django_socketio/socketio_app/admin.py index cb3d77e..8c38f3f 100644 --- a/examples/server/wsgi/django_example/socketio_app/admin.py +++ b/examples/server/wsgi/django_socketio/socketio_app/admin.py @@ -1,4 +1,3 @@ -# flake8: noqa from django.contrib import admin # Register your models here. diff --git a/examples/server/wsgi/django_example/socketio_app/apps.py b/examples/server/wsgi/django_socketio/socketio_app/apps.py similarity index 63% rename from examples/server/wsgi/django_example/socketio_app/apps.py rename to examples/server/wsgi/django_socketio/socketio_app/apps.py index 555c1a8..e8e83ea 100644 --- a/examples/server/wsgi/django_example/socketio_app/apps.py +++ b/examples/server/wsgi/django_socketio/socketio_app/apps.py @@ -2,4 +2,5 @@ from django.apps import AppConfig class SocketioAppConfig(AppConfig): + default_auto_field = 'django.db.models.BigAutoField' name = 'socketio_app' diff --git a/examples/server/wsgi/django_example/socketio_app/management/__init__.py b/examples/server/wsgi/django_socketio/socketio_app/migrations/__init__.py similarity index 100% rename from examples/server/wsgi/django_example/socketio_app/management/__init__.py rename to examples/server/wsgi/django_socketio/socketio_app/migrations/__init__.py diff --git a/examples/server/wsgi/django_example/socketio_app/models.py b/examples/server/wsgi/django_socketio/socketio_app/models.py similarity index 79% rename from examples/server/wsgi/django_example/socketio_app/models.py rename to examples/server/wsgi/django_socketio/socketio_app/models.py index 7f04f3f..71a8362 100644 --- a/examples/server/wsgi/django_example/socketio_app/models.py +++ b/examples/server/wsgi/django_socketio/socketio_app/models.py @@ -1,4 +1,3 @@ -# flake8: noqa from django.db import models # Create your models here. diff --git a/examples/server/wsgi/django_example/socketio_app/static/index.html b/examples/server/wsgi/django_socketio/socketio_app/static/index.html similarity index 100% rename from examples/server/wsgi/django_example/socketio_app/static/index.html rename to examples/server/wsgi/django_socketio/socketio_app/static/index.html diff --git a/examples/server/wsgi/django_example/socketio_app/tests.py b/examples/server/wsgi/django_socketio/socketio_app/tests.py similarity index 80% rename from examples/server/wsgi/django_example/socketio_app/tests.py rename to examples/server/wsgi/django_socketio/socketio_app/tests.py index eb4634d..7ce503c 100644 --- a/examples/server/wsgi/django_example/socketio_app/tests.py +++ b/examples/server/wsgi/django_socketio/socketio_app/tests.py @@ -1,4 +1,3 @@ -# flake8: noqa from django.test import TestCase # Create your tests here. diff --git a/examples/server/wsgi/django_socketio/socketio_app/urls.py b/examples/server/wsgi/django_socketio/socketio_app/urls.py new file mode 100644 index 0000000..eddc173 --- /dev/null +++ b/examples/server/wsgi/django_socketio/socketio_app/urls.py @@ -0,0 +1,7 @@ +from django.urls import path + +from . import views + +urlpatterns = [ + path(r'', views.index, name='index'), +] diff --git a/examples/server/wsgi/django_example/socketio_app/views.py b/examples/server/wsgi/django_socketio/socketio_app/views.py similarity index 100% rename from examples/server/wsgi/django_example/socketio_app/views.py rename to examples/server/wsgi/django_socketio/socketio_app/views.py diff --git a/tox.ini b/tox.ini index 858bc95..8f0ca3c 100644 --- a/tox.ini +++ b/tox.ini @@ -23,7 +23,7 @@ deps= deps= flake8 commands= - flake8 --exclude=".*" --ignore=W503,E402,E722 src/socketio tests examples + flake8 --exclude=".*" --exclude="examples/server/wsgi/django_socketio" --ignore=W503,E402,E722 src/socketio tests examples [testenv:docs] changedir=docs