Skip to main content

Mypy stubs for Django

Project description

mypy logo

pep484 stubs for Django framework

Build Status Checked with mypy Gitter

This package contains type stubs and mypy plugin to provide more precise static types and type inference for Django framework. Django uses some Python "magic" that makes having precise types for some code patterns problematic. This is why we need to accompany the stubs with mypy plugins. The final goal is to be able to get precise types for most common patterns.

Could be run on earlier versions of Django, but expect some missing imports warnings.


pip install django-stubs

Mypy compatibility

django-stubs mypy version django version python version
1.3.0 0.750 2.2.x ^3.6
1.2.0 0.730 2.2.x ^3.6
1.1.0 0.720 2.2.x ^3.6
0.12.x old semantic analyzer (<0.711), dmypy support 2.1.x ^3.6


To make mypy aware of the plugin, you need to add

plugins =

in your mypy.ini or setup.cfg file.

Plugin also requires Django settings module (what you put into DJANGO_SETTINGS_MODULE variable) to be specified.

strict_optional = True

# This one is new:
django_settings_module = mysettings

Where mysettings is a value of DJANGO_SETTINGS_MODULE (with or without quotes)

Current implementation uses Django runtime to extract models information, so it will crash, if your installed apps is not correct. For this same reason, you cannot use reveal_type inside global scope of any Python file that will be executed for django.setup().

In other words, if your runserver crashes, mypy will crash too.

This fully working typed boilerplate can serve you as an example.


Type implementation monkey-patches Django to add __class_getitem__ to the Manager class. If you would use Python3.7 and do that too in your code, you can make things like

class MyUserManager(models.Manager['MyUser']):

class MyUser(models.Model):
    objects = MyUserManager()

work, which should make a error messages a bit better.

Otherwise, custom type will be created in mypy, named MyUser__MyUserManager, which will rewrite base manager as models.Manager[User] to make methods like get_queryset() and others return properly typed QuerySet.

To get help

We have Gitter here:

If you think you have more generic typing issue, please refer to and their Gitter.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-stubs, version 1.3.2
Filename, size File type Python version Upload date Hashes
Filename, size django_stubs-1.3.2-py3-none-any.whl (298.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size django-stubs-1.3.2.tar.gz (159.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page