PEP-484 stubs for django-rest-framework
Project description
pep484 stubs for Django REST framework
Mypy stubs for Django REST Framework. Supports Python 3.8 and up.
Installation
pip install djangorestframework-stubs[compatible-mypy]
To make mypy aware of the plugin, you need to add
[mypy]
plugins =
mypy_drf_plugin.main
in your mypy.ini
file.
FAQ
Model instance is inferred as Any
instead of my Model
class
When subclassing ModelSerializer
, add a type argument to type-hint the related model class, for example:
class MyModelSerializer(serializers.ModelSerializer[MyModel]):
class Meta:
model = MyModel
fields = ("id", "example")
Which means that methods where the model is being passed around will know the actual type of the model instead of being Any
. The instance
attribute on the above serializer will be Union[MyModel, typing.Sequence[MyModel], None]
.
To get help
We have Gitter here: https://gitter.im/mypy-django/Lobby If you think you have more generic typing issue, please refer to https://github.com/python/mypy and their Gitter.
Contributing
This project is open source and community driven. As such we encourage contributions big and small. You can contribute by doing any of the following:
- Contribute code (e.g. improve stubs, add plugin capabilities, write tests etc) - to do so please follow the contribution guide.
- Assist in code reviews and discussions in issues.
- Identify bugs and issues and report these
You can always also reach out in gitter to discuss your contributions!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for djangorestframework-stubs-3.14.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8ee8719bfeb647b92cc200e15b3cc9813d2e4468c8190777a55a121542a4b2d4 |
|
MD5 | 9263b8b54a7488fc2f06989217cd8c18 |
|
BLAKE2b-256 | 0a0e7a151baefa940314c2b26863e5041f29195f506748e38b4841740f198786 |
Hashes for djangorestframework_stubs-3.14.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5be8275dd05d6629b3d1688929586ef7b6bc66b4f3f728b5e0389305f07c7a7f |
|
MD5 | 62bbf67d003c4cf0284f2e497ffa4234 |
|
BLAKE2b-256 | f3d31d8d934893eaca90a96b0093f72c8a05e47e1616f90e71699e275ace15f5 |