Registry /
type-stubs / djangorestframework-types
Install & Compatibility
Where this runs
tested against v0.9.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.920 runs
installs and imports cleanly · install 0.0s · import 0.000s · 82.1MB
glibcpy 3.10–3.920 runs
installs and imports cleanly · install 3.6s · import 0.000s · 81MB
80MB installed
● package 80MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
DrfPlugin
✓ plugins = drf_types.plugin.DrfPlugin
This symbol is referenced in `mypy.ini` for configuration, not directly imported into Python code at runtime.
To enable type checking for Django REST Framework, you *must* configure your `mypy.ini` file in your project root, adding the `drf_types.plugin.DrfPlugin` (see warnings section for details on `mypy.ini`). The Python example demonstrates how `djangorestframework-types` allows MyPy to correctly infer types for DRF serializers and their validated data, catching potential issues at development time. Save this as a Python file and run `mypy your_file.py` after installation and `mypy.ini` setup.
# mypy.ini (create or update this file in your project root):
# [mypy]
# plugins =
# drf_types.plugin.DrfPlugin
#
# [drf-types]
# # Optional: List your custom DRF apps for deeper introspection
# # apps =
# # my_app
# # another_app
# quickstart_example.py (save this as a Python file):
from rest_framework import serializers
import os # For os.environ.get if needed for real data/auth
class UserSerializer(serializers.Serializer):
id: serializers.IntegerField = serializers.IntegerField(read_only=True)
username: serializers.CharField = serializers.CharField(max_length=150)
email: serializers.EmailField = serializers.EmailField()
def create(self, validated_data: dict[str, str]) -> dict[str, str]:
# In a real application, this would create a User model instance.
# This example just returns the data for demonstration.
print(f"Creating user: {validated_data.get('username', 'N/A')}")
return validated_data
def update(self, instance: dict, validated_data: dict[str, str]) -> dict:
# In a real application, this would update a User model instance.
print(f"Updating user: {instance.get('id', 'N/A')}")
instance['username'] = validated_data.get('username', instance.get('username', ''))
instance['email'] = validated_data.get('email', instance.get('email', ''))
return instance
# Example usage with type checking:
initial_data = {
"username": "testuser_" + os.environ.get('TEST_ID', '1'),
"email": "test@example.com"
}
serializer = UserSerializer(data=initial_data)
serializer.is_valid(raise_exception=True)
# `validated_data` is now correctly typed thanks to djangorestframework-types
validated_data: dict[str, str] = serializer.validated_data
# MyPy will detect issues like accessing non-existent keys:
# print(validated_data['non_existent_field']) # Mypy would flag this as an error
print(f"Validated username: {validated_data['username']}")
# To run type checking, ensure mypy.ini is configured as above, then:
# mypy quickstart_example.py
Upgrade
Version history
0.9.0latest on PyPI · released Oct 10, 2024
Audit
Dependencies
djangorestframeworkrequiredProvides type stubs for this library; an existing DRF project is assumed.
django-stubsoptionalHighly recommended for full type coverage as DRF builds on Django's core types.
mypyrequiredRequired to actually perform static type checking using these stubs.