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.4.post1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6e9df462168d9619f0788d61c2eea0cfe6b127870789e71a7c928b217f85a20a |
|
MD5 | 1801ba13423482349e24d4a9eedbad28 |
|
BLAKE2b-256 | 0855f755c1becc6084ca2605c78a4e053250015d80735fa204efcac39abdd33f |
Hashes for sentry_forked_djangorestframework_stubs-3.14.4.post1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 86793ad0c57306e9b9bb37792466546f5ac5b4909203cb891be64ec16188e1de |
|
MD5 | 03807d6f631d5426b7ab950e01422414 |
|
BLAKE2b-256 | 8252ef658a1e43a181fd3f6b0b22e3430fdcb096bf5854ecc0d9be7b477e8246 |