PEP-484 stubs for django-rest-framework
Project description
sentry-forked-djangorestframework-stubs
new release
make a new branch for the fork of an upstream tag:
git remote add upstream git@github.com:typeddjango/djangorestframework-stubs
git fetch upstream --tags
git push origin --tags
git checkout 1.2.3 -b sentry-1.2.3
- cherry-pick the craft / release commit(s) into your branch from
master
- cherry-pick relevant commit(s) from previous releases
releases are done through craft in the release.yml workflow -- make sure to
target your particular branch with a -#
release postfix (like 1.2.3-1
)
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 sentry-forked-djangorestframework-stubs-3.14.5.post1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c92223406425e0333b7c090b851cb7b5472b49314eb7bf9868f9ba8f912a7e5c |
|
MD5 | 429194e7de7b747171d6ab4d3115c064 |
|
BLAKE2b-256 | 70507a66ccd293636685ce6ea204819211cd87bef130e9f2f37ccae3bdb21981 |
Hashes for sentry_forked_djangorestframework_stubs-3.14.5.post1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c2d2f89c82c6291ca1fd55bb0c7069c6515f4b13dd7ecdba6d1b105250492f18 |
|
MD5 | 73c2bd492215cd6532064227f7886a61 |
|
BLAKE2b-256 | 409eaee77f05fefccf7d003a76c9790b7796716cd199c276be8879d684ddff23 |