This project extends Django REST Framework to allow use of Python's type hints for automatically validating view parameters, as well as supporting typed attributes and annotation-generated fields on serializers.
Deriving automatic behavior from type annotations has become increasingly popular with the FastAPI and Django Ninja frameworks. The goal of this project is to provide these benefits to the DRF ecosystem.
Main benefits:
- View inputs can be individually declared, not buried inside all-encompassing
request
objects. - Type annotations can replace repetitive view validation/sanitization code.
- Simple serializers can have their fields auto-generated from annotations
- Validated serializer data can be accessed from attributes, with their types known to the IDE
- Pydantic models are compatible types for view parameters. Annotate your POST/PUT functions with them to automatically validate incoming request bodies.
Documentation: https://rsinger86.github.io/drf-typed
Source Code: https://github.com/rsinger86/drf-typed
from rest_typed.views import typed_api_view
"""
GET /users/registered/?registered_on=2019-03-03&staff=yes
"""
@typed_api_view(["GET"])
def get_users(registered_on: date = None, staff: bool = None):
print(registered_on, is_staff)
# date(2019, 3, 3) True
data = query_orm(registered_on, is_staff)
return Response(data)
from datetime import date
from rest_typed.serializers import TSerializer
class MovieSerializer(TSerializer):
title: str # same as: CharField(required=True, allow_null=False)
release_date: date # same as: DateField(required=True, allow_null=False)
description = None # same as: DateField(default=None)
movie = MovieSerializer(data={
"title": "The Last Duel",
"release_date": "2021-10-15",
})
movie.is_valid(raise_exception=True)
print(movie.validated_data)
"""
{
"title": "The Last Duel",
"release_date": date(2021, 10, 15),
"description": None
}
"""
# Or access attributes directly:
print(movie.title) # The Last Duel
print(movie.release_date) # date(2021, 10, 15)
The IDE can help you understand types and auto-complete attributes:
Install using:
pip install drf-typed
Python 3.8 or higher is required.
- Fixes setup.py for finding packages
- Fixes setup.py for finding packages
- Docs improvements
- Updates setup.py to include stubs package
- First release
Tests are found in a simplified Django project in the /tests
folder. Install the project requirements and do ./manage.py test
to run them.
See License.