Skip to main content

Extensions and monkey-patching for django-stubs

test Checked with mypy StackOverflow

This package contains extensions and monkey-patching functions for the django-stubs package. Certain features of django-stubs (i.e. generic django classes that don't define the __class_getitem__ method) require runtime monkey-patching, which can't be done with type stubs. These extensions were split into a separate package so library consumers don't need mypy as a runtime dependency (#526).

Installation

pip install django-stubs-ext

Usage

In your Django application, use the following code:

import django_stubs_ext

django_stubs_ext.monkeypatch()

This only needs to be called once, so the call to monkeypatch should be placed in your top-level settings. Real-life example can be found here.

Version compatibility

Since django-stubs supports multiple Django versions, this package takes care to only monkey-patch the features needed by your django version, and decides which features to patch at runtime. This is completely safe, as (currently) we only add a __class_getitem__ method that does nothing:

@classmethod
def __class_getitem__(cls, *args, **kwargs):
    return cls

To get help

For help with django-stubs, please view the main repository at https://github.com/typeddjango/django-stubs

Contributing

The django-stubs-ext package is part of the django-stubs monorepo. If you would like to contribute, please view the django-stubs contribution guide.

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

django_stubs_ext-6.0.9.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

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

django_stubs_ext-6.0.9-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

Details for the file django_stubs_ext-6.0.9.tar.gz.

File metadata

  • Download URL: django_stubs_ext-6.0.9.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for django_stubs_ext-6.0.9.tar.gz
Algorithm Hash digest
SHA256 6777de6d0a059f55ea1d53839de84c2ae96eae131b75fd00c3ee8f6678d9f6d7
MD5 ebd55ce666c5c6a575de87e7037e0582
BLAKE2b-256 1e1f7a4c5f1c1b1b6573623c91c247dfe1f226ed14fa0690e218842bfb5ff88a

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_stubs_ext-6.0.9.tar.gz:

Publisher: release.yml on typeddjango/django-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 django_stubs_ext-6.0.9-py3-none-any.whl.

File metadata

File hashes

Hashes for django_stubs_ext-6.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 267cb4d0bc87a6c2a0edd0f0dfa59696efd3d21a86b1d346b502fe13c6ea28ef
MD5 45d2051a741a81060f25b883cc2abd09
BLAKE2b-256 032b989757760d725417e6131366a56f5cce88370885b6f2e064548bdc9c2cc2

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_stubs_ext-6.0.9-py3-none-any.whl:

Publisher: release.yml on typeddjango/django-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 Sentry Error logging StatusPage Status page