Skip to content

brianhelba/django-stubs

Repository files navigation

mypy logo

pep484 stubs for Django framework

Build Status Checked with mypy

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.

Installation

git clone https://github.com/mkurnikov/django-stubs.git
cd django-stubs
pip install -U .

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

[mypy]
plugins =
    mypy_django_plugin.main

in your mypy.ini file.

Also, it uses value of DJANGO_SETTINGS_MODULE from the environment, so set it before execution, otherwise some features will not work.

About

PEP-484 stubs for Django

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%