djangorestframework-stubs

What it is and what it does

djangorestframework-stubs is a collection of type stubs that teach mypy how to understand Django REST Framework's type signatures. It bridges the gap between DRF's dynamic nature and Python's static type system, allowing you to catch type errors at development time rather than runtime.

The package works by providing stub files (.pyi) that describe DRF's public API in terms mypy understands, plus a mypy plugin that enhances inference for common patterns. You install it alongside your project's type-checking setup, configure mypy to load the plugin, and then annotate your code with generic type parameters to get precise type information for model instances and method signatures. It depends on django-stubs, typing-extensions, and types-pyyaml.

Use it for:

• Catch type errors in CI/CD before deployment by running mypy on code using Django REST Framework.
• Get IDE autocomplete and type hints when writing custom methods and validators.
• Ensure serializer subclasses correctly type-hint their related model class to prevent Any inference.
• Validate that view methods receive and return the correct types.
• Migrate a Django REST Framework codebase toward full type safety incrementally.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides PEP-484 type stubs for Django REST Framework to enable mypy static type checking of DRF code.

Yes, if you use Django REST Framework and mypy for type checking. The package is actively maintained, has no known vulnerabilities, and low install friction. It's essential for teams that want static type safety in DRF projects. Install it as part of your development dependencies and configure the mypy plugin in your mypy.ini.

Install

djangorestframework-stubs on PyPI

pip install djangorestframework-stubs

uv add djangorestframework-stubs

poetry add djangorestframework-stubs

Installing djangorestframework-stubs

Before you install

Low install friction with a pure-wheel distribution. Actively maintained with a release 2 days ago. Requires Python 3.10 or later and depends on django-stubs, typing-extensions, and types-pyyaml.

License in practice

MIT license is permissive; you can use this in commercial and private projects with minimal restrictions.

Quickstart

pip install djangorestframework-stubs

Add to mypy.ini:
[mypy]
plugins =
    mypy_drf_plugin.main

Requires Python 3.10 or later; mypy must be configured with the mypy_drf_plugin.main plugin in mypy.ini for full type support.

Verify before relying

• Whether the plugin handles all serializer patterns or has known gaps in type inference.
• Performance impact of the mypy plugin on type-checking speed for large projects.
• Specific version compatibility with different versions of django-stubs and typing-extensions.

Package facts

Evidence: djangorestframework_stubs-3.18.0-py3-none-any.whl

Tags

More Quality Assurance packages