Skip to main content

Monkey-patching and extensions for django-stubs

Project description

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!

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

django_stubs_ext-5.2.9.tar.gz (6.5 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-5.2.9-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: django_stubs_ext-5.2.9.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for django_stubs_ext-5.2.9.tar.gz
Algorithm Hash digest
SHA256 6db4054d1580657b979b7d391474719f1a978773e66c7070a5e246cd445a25a9
MD5 f577ab4adf13d0e5276fa0f127a60332
BLAKE2b-256 55039c2be939490d2282328db4611bc5956899f5ff7eabc3e88bd4b964a87373

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_stubs_ext-5.2.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-5.2.9-py3-none-any.whl.

File metadata

File hashes

Hashes for django_stubs_ext-5.2.9-py3-none-any.whl
Algorithm Hash digest
SHA256 230c51575551b0165be40177f0f6805f1e3ebf799b835c85f5d64c371ca6cf71
MD5 084d65913a5e9480cc33f1b69366cefe
BLAKE2b-256 9bf70d5f7d7e76fe972d9f560f687fdc0cab4db9e1624fd90728ca29b4ed7a63

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_stubs_ext-5.2.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 Pingdom Monitoring Sentry Error logging StatusPage Status page