Skip to main content

PEP-484 stubs for django-rest-framework

Project description

mypy logo

pep484 stubs for Django REST framework

Build status Checked with mypy Gitter StackOverflow

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:

  1. Contribute code (e.g. improve stubs, add plugin capabilities, write tests etc) - to do so please follow the contribution guide.
  2. Assist in code reviews and discussions in issues.
  3. Identify bugs and issues and report these

You can always also reach out in gitter to discuss your contributions!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

djangorestframework_stubs-3.16.0.tar.gz (34.8 kB view details)

Uploaded Source

Built Distribution

djangorestframework_stubs-3.16.0-py3-none-any.whl (54.7 kB view details)

Uploaded Python 3

File details

Details for the file djangorestframework_stubs-3.16.0.tar.gz.

File metadata

File hashes

Hashes for djangorestframework_stubs-3.16.0.tar.gz
Algorithm Hash digest
SHA256 8c5ccdfe9271b1a37946a3564dc3714d521cd3f2f8695e528808e0c700538243
MD5 7d47b4ee1f05bee6ea5290e791e1ec67
BLAKE2b-256 472b45a1c9ccb7c4a1f79112a2b4b65a1abd3ee9d4ed1a80d21736bd8f999750

See more details on using hashes here.

Provenance

The following attestation bundles were made for djangorestframework_stubs-3.16.0.tar.gz:

Publisher: release.yml on typeddjango/djangorestframework-stubs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file djangorestframework_stubs-3.16.0-py3-none-any.whl.

File metadata

File hashes

Hashes for djangorestframework_stubs-3.16.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2085a6e023de65843d4d53fe5abc73fbbc3ef380a59919ad9801182f6bb435de
MD5 2fda1c7a06e5ad770e9e8df990d41269
BLAKE2b-256 23f850be82c084173adb95f2a925f6336aa53b97ea7ce6fe1dc943ddc20b1193

See more details on using hashes here.

Provenance

The following attestation bundles were made for djangorestframework_stubs-3.16.0-py3-none-any.whl:

Publisher: release.yml on typeddjango/djangorestframework-stubs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page