django_stubs_mypy_type_checking_quickstart_config.py

1# Installation required:
2# pip install django-stubs mypy
3
4# configuration is typically done in mypy.ini or setup.cfg
5# but you can also use pyproject.toml as shown below:
6
7"""
8# pyproject.toml configuration:
9[tool.mypy]
10plugins = ["mypy_django_plugin.main"]
11
12[tool.django-stubs]
13django_settings_module = "myproject.settings"
14"""
15
16# Example of type-hinted Django code:
17from django.db import models
18from django.http import HttpRequest, HttpResponse
19from django.shortcuts import render
20
21class MyModel(models.Model):
22    name = models.CharField(max_length=100)
23
24    def __str__(self) -> str:
25        return self.name
26
27def my_view(request: HttpRequest) -> HttpResponse:
28    # django-stubs allows mypy to understand that .objects returns a QuerySet
29    items = MyModel.objects.all()
30    return render(request, "index.html", {"items": items})