ASGI Ref

3.11.1 · active · verified Sat Mar 28

ASGI specification and utilities, version 3.11.1, released on a regular cadence. Provides ASGI specs, helper code, and adapters for Python applications.

Warnings

breaking Import paths have changed in asgiref 3.11.1; ensure correct imports to avoid ImportError.
Fix: Update import statements to reflect the new module structure.
gotcha Using AsyncToSync without proper context can lead to deadlocks; ensure it's used within an appropriate event loop.
Fix: Use AsyncToSync within an event loop or ensure it's called from an asynchronous context.

Install

pip install asgiref Install asgiref

Imports

ASGIApp
```
from asgiref.typing import ASGIApp
```
Importing ASGIApp from asgiref.typing is the correct approach.
AsyncToSync
```
from asgiref.sync import AsyncToSync
```
AsyncToSync is used to call asynchronous code from synchronous code.

Quickstart

A basic ASGI application setup using asgiref and Channels, including routing and middleware.

import os
from asgiref.sync import AsyncToSync
from channels.routing import ProtocolTypeRouter, URLRouter
from channels.auth import AuthMiddlewareStack
from django.urls import path

os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'your_project.settings')

application = ProtocolTypeRouter({
    'http': get_asgi_application(),
    'websocket': AuthMiddlewareStack(
        URLRouter([
            path('ws/some_path/', your_consumer.as_asgi()),
        ])
    ),
})

view raw JSON →