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.9.tar.gz (32.8 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.9-py3-none-any.whl (57.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for djangorestframework_stubs-3.16.9.tar.gz
Algorithm Hash digest
SHA256 b1abb97490c90c85eabcd09b8ecbadae1b9360f21ad3021abf830227c0129697
MD5 4178b9d348761c3e784ba549e767d0c1
BLAKE2b-256 3084fa0e31f763ee35152a418c2a456efdd8047a9da0f5909110147b70382191

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for djangorestframework_stubs-3.16.9-py3-none-any.whl
Algorithm Hash digest
SHA256 27b3e245d5f9c22ff6988d9e54388249f98f88608cc2b365b71e9f39dd096958
MD5 cd74b3c001298670f39ccccdff2f61c7
BLAKE2b-256 5abee53e3b89eaa30c21e036ae4d2ee88a92ef8cb43678400901748ddad870c5

See more details on using hashes here.

Provenance

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