Django Stubs Extensions

6.0.2 · active · verified Thu Apr 09

django-stubs-ext is a Python library that provides essential monkey-patching and extensions for `django-stubs`, significantly enhancing static type checking for Django projects using Mypy. It ensures better compatibility and stub coverage for advanced Django features and commonly used patterns. The library is actively maintained with frequent updates, often aligning with new Django and Mypy releases, and is currently at version 6.0.2.

Warnings

breaking Version 6.0.0 introduced significant changes, including dropping support for older Django versions and primarily targeting Django 6.0. Ensure your Django project is compatible.
Fix: Upgrade your Django project to a compatible version (Django 6.0 or newer). Consider pinning `django-stubs-ext` to `~=5.2` if you are on an older Django version.
breaking `django-stubs-ext` versions 6.0.x are designed for `mypy@1.20` and newer. Using older Mypy versions might lead to compatibility issues or incorrect type checking results.
Fix: Ensure your Mypy installation is updated to version 1.20 or newer (`pip install --upgrade mypy`).
gotcha Version 6.0.0 of `django-stubs-ext` contained a known crash bug when checking `QuerySet.order_by()` with abstract models. This issue was resolved in subsequent patch releases.
Fix: Upgrade to `django-stubs-ext` version 6.0.1 or newer (`pip install --upgrade django-stubs-ext`).
gotcha For `django-stubs-ext` to function correctly, it must be used in conjunction with `django-stubs`. Ensure both libraries are installed and your Mypy configuration points to the `django_stubs_ext.mypy_plugin`.
Fix: Install `django-stubs` (`pip install django-stubs`) and correctly configure `mypy.ini` as described in the quickstart.

Install

pip install django-stubs-ext Install `django-stubs-ext`

Imports

django_stubs_ext.mypy_plugin
```
Add 'django_stubs_ext.mypy_plugin' to `mypy_plugins` in `mypy.ini`.
```
This library primarily functions as a Mypy plugin, rather than through direct Python symbol imports into user code.

Quickstart

To enable `django-stubs-ext`, add its plugin entry to your `mypy.ini` (or equivalent Mypy configuration file) under the `[mypy]` section. This activates the extensions and monkey-patches provided by the library.

[mypy]
plugins = django_stubs_ext.mypy_plugin

view raw JSON →