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.15.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 34539871895d66d382b6ae3655d9f95c1de7733cf50bc29097638d367ed3117d |
|
MD5 | 27627105bf7e6393a12942422deb05a6 |
|
BLAKE2b-256 | f30040ee7702b69d32bd88240468a7cdc4b52aca42e14513d04ec8e16b5c1c59 |
Hashes for djangorestframework_stubs-3.15.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 79dc9018f5d5fa420f9981eec9f1e820ecbd04719791f144419cdc6c5b8e29bd |
|
MD5 | b517a86df031e14d665695d672c060fa |
|
BLAKE2b-256 | a4f4463fe341a7fe4b79da9fef65327b8e8d696639eba592f9fced6b6b8593ff |