Skip to main content

PEP-484 stubs for django-rest-framework

Project description

mypy logo

pep484 stubs for Django REST framework

test Checked with mypy Gitter StackOverflow

Mypy stubs for Django REST Framework. Supports Python 3.10 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 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.5.tar.gz (32.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

djangorestframework_stubs-3.16.5-py3-none-any.whl (56.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for djangorestframework_stubs-3.16.5.tar.gz
Algorithm Hash digest
SHA256 1de13fad78b7de3f7ee34dcc1864929adc658342508567263eaff96a4b32312e
MD5 f65ac37905158a538239730d045a9e48
BLAKE2b-256 4a8110d0139796e3df5c48e9383ef73e3a999351415e94cc427a4546f79bad07

See more details on using hashes here.

Provenance

The following attestation bundles were made for djangorestframework_stubs-3.16.5.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.5-py3-none-any.whl.

File metadata

File hashes

Hashes for djangorestframework_stubs-3.16.5-py3-none-any.whl
Algorithm Hash digest
SHA256 aebd45bc2cf5e52b90651c548ad25c66d5d8d2b11c48147cbaba87498eefd211
MD5 c448e40b820f167f5ded1812191fe223
BLAKE2b-256 93339c8d203d9e409736665e9f4ed2b9986dfb77774c7d17dab392ed498cb201

See more details on using hashes here.

Provenance

The following attestation bundles were made for djangorestframework_stubs-3.16.5-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 Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page