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.2.tar.gz (34.8 kB view details)

Uploaded Source

Built Distribution

djangorestframework_stubs-3.16.2-py3-none-any.whl (54.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for djangorestframework_stubs-3.16.2.tar.gz
Algorithm Hash digest
SHA256 db57341e52f002fee2980d01e42f078d54f5df74cceacaff7be8a506099475e1
MD5 aea764fb1d606f0fe338d7c263d796ee
BLAKE2b-256 fbe705f03d93264df3b366e61b04f4dc60cdb743a67fcb74604e9d843cb75914

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for djangorestframework_stubs-3.16.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f2709bace240be384f0f29af7656c199c4dd5d17fd6cc6f0618c62ec77315be8
MD5 a1a27d825b836abf4d4cfabed8db9885
BLAKE2b-256 e60dca9c6cecc538e558131da30329215d877161c2dbe0bd97ee354490305526

See more details on using hashes here.

Provenance

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