Extend example app to have an async version.

Author: tim-schilling

Makefile

@@ -6,6 +6,13 @@ example:
 		--noinput --username="$(USER)" --email="$(USER)@mailinator.com"
 	python example/manage.py runserver
 
+example_async:
+	python example/manage.py migrate --noinput
+	-DJANGO_SUPERUSER_PASSWORD=p python example/manage.py createsuperuser \
+		--noinput --username="$(USER)" --email="$(USER)@mailinator.com"
+	daphne example.asgi:application
+
+
 test:
 	DJANGO_SETTINGS_MODULE=tests.settings \
 		python -m django test $${TEST_ARGS:-tests}

docs/changes.rst

@@ -23,6 +23,7 @@ Serializable (don't include in main)
 * Make ``Panel.panel_id`` a class member.
 * Update all panels to utilize data from ``Panel.get_stats()`` to load content
   to render. Specifically for ``Panel.title`` and ``Panel.nav_title``.
+* Extend example app to contain an async version.
 
 Pending
 -------

example/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for example_async 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.2/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "example.async_.settings")
+
+application = get_asgi_application()

example/async_/__init__.py

@@ -0,0 +1,5 @@
+"""Django settings for example project."""
+
+from ..settings import *  # noqa: F403
+
+ROOT_URLCONF = "example.async_.urls"

example/async_/settings.py

@@ -0,0 +1,9 @@
+from django.urls import path
+
+from example.async_ import views
+from example.urls import urlpatterns as sync_urlpatterns
+
+urlpatterns = [
+    path("async/db/", views.async_db_view, name="async_db_view"),
+    *sync_urlpatterns,
+]

example/async_/urls.py

@@ -0,0 +1,9 @@
+from django.contrib.auth.models import User
+from django.http import JsonResponse
+
+
+async def async_db_view(request):
+    names = []
+    async for user in User.objects.all():
+        names.append(user.username)
+    return JsonResponse({"names": names})

example/async_/views.py

@@ -28,6 +28,7 @@
 MIDDLEWARE = [
     "debug_toolbar.middleware.DebugToolbarMiddleware",
     "django.middleware.security.SecurityMiddleware",
+    "whitenoise.middleware.WhiteNoiseMiddleware",
     "django.contrib.sessions.middleware.SessionMiddleware",
     "django.middleware.common.CommonMiddleware",
     "django.middleware.csrf.CsrfViewMiddleware",

example/settings.py

@@ -23,9 +23,12 @@ <h1>Index of Tests</h1>
       <button id="incrementFetch" data-url="{% url 'ajax_increment' %}" type="button">Increment via fetch</button>
       <button id="incrementXHR" data-url="{% url 'ajax_increment' %}" type="button">Increment via XHR</button>
     </p>
+    <button id="asyncRequest" data-url="{% url 'async_db_view' %}" type="button">Make async call</button>
+
   <script>
     const incrementFetch = document.querySelector("#incrementFetch");
     const incrementXHR = document.querySelector("#incrementXHR");
+    const asyncButton = document.querySelector("#asyncRequest");
     const value = document.querySelector("#session-value");
     incrementFetch.addEventListener("click", function () {
       fetch(incrementFetch.dataset.url).then( function (response) {
@@ -44,6 +47,14 @@ <h1>Index of Tests</h1>
       xhr.open('GET', incrementXHR.dataset.url, true);
       xhr.send('');
     });
+    asyncButton.addEventListener("click", function () {
+      fetch(asyncButton.dataset.url).then( function (response) {
+        response.json().then(function(data) {
+          console.log(data)
+        });
+      });
+    });
+
   </script>
   </body>
 </html>

example/templates/index.html

@@ -4,6 +4,10 @@ Django
 sqlparse
 Jinja2
 
+# Django Async
+daphne
+whitenoise  # To avoid dealing with static files
+
 # Testing
 
 coverage[toml]