Skip to main content
mypy logo

pep484 stubs for Django REST framework

test Checked with mypy Gitter StackOverflow

Mypy stubs for Django REST Framework. Supports Python 3.11 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!

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.18.1.tar.gz (32.4 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.18.1-py3-none-any.whl (55.7 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for djangorestframework_stubs-3.18.1.tar.gz
Algorithm Hash digest
SHA256 65ed4a9ea094616759a2cba4fe0ad85efe25b471b28281b790bfefb46704c64a
MD5 3cb3de44caaf65b4991a3a9c9e57f463
BLAKE2b-256 6b71a7727b07e0433da02fb1ea22994f492ecb437a1fe7be5bf952dbb545a0f5

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for djangorestframework_stubs-3.18.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a2021f45f7759b493504c2a721f112ec4fd677753590c1ba346f4ebfb49a7f03
MD5 1a442d81e6bf0438c894dda26b6c23c4
BLAKE2b-256 f71ce266828fe2b78484651667976f8539e47b4e511a266424b890f613c6b7ad

See more details on using hashes here.

Provenance

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

Release history Release notifications | RSS feed

This release

3.18.1 This release

2 files

3.18.0

2 files

3.17.1

2 files

3.17.0

2 files

3.16.9

2 files

3.16.8

2 files

3.16.7

2 files

3.16.6

2 files

3.16.5

2 files

3.16.4

2 files

3.16.3

2 files

3.16.2

2 files

3.16.1

2 files

3.16.0

2 files

3.15.4

2 files

3.15.3

2 files

3.15.2

2 files

3.15.1

2 files

3.15.0

2 files

3.14.5

2 files

3.14.4

2 files

3.14.3

2 files

3.14.2

2 files

3.14.1

2 files

3.14.0

2 files

1.10.0

2 files

1.9.1

2 files

1.9.0

2 files

1.8.0

2 files

1.7.0

2 files

1.6.0

2 files

1.5.0

2 files

1.4.0

2 files

1.3.0

2 files

1.2.0

2 files

1.1.0

2 files

1.0.0

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.0

2 files

0.2.0

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page