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.8.tar.gz (32.3 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.8-py3-none-any.whl (56.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for djangorestframework_stubs-3.16.8.tar.gz
Algorithm Hash digest
SHA256 f6d464b54fa2f929610e957446c04e6ac29558265418e0a2d9f653a4cdd410b5
MD5 0d056a9e854b5043d540333cccdf562e
BLAKE2b-256 78d587166a827833eb39703856ef957ca0fb4e9d15285331251186a2e738c20c

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for djangorestframework_stubs-3.16.8-py3-none-any.whl
Algorithm Hash digest
SHA256 c5bf61def0f330a071dd5f470f05710189d06c467b3f3e186b32c5a23d4952fb
MD5 7d71ca6a10d6db2a95e74409dc625ee7
BLAKE2b-256 eae9d9c363b08d07d975c21793fe821b2020dfd3627ac4ce19c5c12df94ce9d0

See more details on using hashes here.

Provenance

The following attestation bundles were made for djangorestframework_stubs-3.16.8-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