Contrib dependencies and upstream documentation¶
aiodrf documents its adapters and execution boundaries. The linked upstream manuals define each dependency's configuration, security controls and supported features. Install only the integrations in use; an optional adapter does not make the dependency's entire API asynchronous.
Use the documentation version matching the installed package. The ecosystem version reference identifies the dependency profiles, and the ecosystem guide records tested contracts. Inclusion here is not an unrestricted compatibility or support guarantee. Examples requiring services are in ecosystem-services.
Cache and data access¶
| Integration | Upstream documentation | aiodrf scope |
|---|---|---|
contrib.redis |
redis-py asyncio, retry configuration | Native cache operations and pool ownership; cache guide |
contrib.valkey |
django-valkey async backend, valkey-py connections, retries | Instance-owned vendor pools, or the separate native contrib backend; resilience |
| Django cache interoperability | Django cache framework, django-redis | Synchronous consumers and async thread-adapted calls; no replacement of vendor plugin APIs |
contrib.opensearch |
django-opensearch-dsl, opensearch-py | Document preparation and native client writes; NoSQL guide |
| Elasticsearch examples | django-elasticsearch-dsl, Elastic Python client and integrated DSL | Django indexing and separately owned native async clients; not OpenSearch clients |
contrib.mongodb |
Django MongoDB Backend, PyMongo | Field/schema integration; Django and direct async-driver paths remain distinct |
| MongoDB serializer integration | MongoDB's DRF integration guide, django-mongodb-extensions | Vendor model serializers and embedded fields alongside the aiodrf MongoDB adapter |
contrib.async_backend |
django-async-backend, Psycopg async operations | Explicit native PostgreSQL adapter; version coupling and limitations |
Serialization, schemas and filtering¶
| Integration | Upstream documentation | aiodrf scope |
|---|---|---|
contrib.msgspec, cache_codecs.MsgspecCodec |
msgspec | Explicit typed schemas, eligible DRF compilation and typed cache values; serializer contracts |
contrib.pydantic, cache_codecs.PydanticCodec |
Pydantic | Explicit models/TypeAdapter, eligible DRF compilation and typed cache values; vendor field hooks remain synchronous |
contrib.spectacular |
drf-spectacular | Schema extensions, QUERY handling and streaming schemas |
contrib.django_filters |
django-filter | Awaitable filter backend with the vendor's filtering semantics; integration |
| rest-filters compatibility | rest-filters | Tested vendor backend, not a copied filtering implementation; integration |
contrib.builtin optimizations and the compiler's eligibility rules are aiodrf
implementations, not vendor features. Their configuration belongs in the
settings reference and optimization guide.
Authentication and permissions¶
| Integration | Upstream documentation | aiodrf scope |
|---|---|---|
contrib.simplejwt |
Simple JWT | Explicit credential-presence checks avoid unnecessary worker dispatch; token authentication and settings remain upstream |
contrib.knox |
Knox documentation | Credential-presence checks; token lookup remains worker-adapted and token expiry remains upstream |
contrib.auth_kit |
DRF Auth Kit | Cookie/header presence checks; vendor views and cookie/CSRF policy are not replaced |
contrib.permissions |
Django authentication, DRF permissions, django-guardian, rules | Preserves synchronous permission-backend participation; authentication and permission integration |
Runtime, instrumentation and migration¶
| Integration | Upstream documentation | aiodrf scope |
|---|---|---|
contrib.whitenoise |
WhiteNoise, ServeStatic | Explicit dual-mode adapter versus a separate ASGI-oriented option; static-file guide |
contrib.opentelemetry |
OpenTelemetry Python API, Django instrumentation | Optional spans; SDK/exporter setup, sampling and instrumentation are application choices |
| Tasks extra | Django Tasks, django-tasks backport | Backport selection and enqueue contracts; no replacement task queue; task guide |
| ASGI lifespan | ASGI lifespan specification, asgi-lifespan, HTTPX | Managed resources; test transport and lifespan ownership are separate |
contrib.adrf_compat |
ADRF | Explicit migration shim, not a default dependency or a runtime performance extension |
| Codemod extra | LibCST | Migration source transformations, not runtime request processing |
contrib.convert generates schema source from DRF, msgspec or Pydantic
definitions; it is separate from the LibCST migration codemod. See
management commands and the serializer guide.
Consult runtime adaptations before selecting an integration that changes vendor registrations or imports. Default contrib use does not authorize global Django/DRF patches. Packages tested without an adapter are listed separately in the ecosystem catalogue.