Skip to main content

Monkey-patching and extensions for django-stubs

Project description

Extensions and monkey-patching for django-stubs

Build status Checked with mypy Gitter

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

We have a Gitter chat here: https://gitter.im/mypy-django/Lobby If you think you have a more generic typing issue, please refer to https://github.com/python/mypy and their Gitter.

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

Uploaded Source

Built Distribution

django_stubs_ext-5.1.2-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: django_stubs_ext-5.1.2.tar.gz
  • Upload date:
  • Size: 9.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for django_stubs_ext-5.1.2.tar.gz
Algorithm Hash digest
SHA256 421c0c3025a68e3ab8e16f065fad9ba93335ecefe2dd92a0cff97a665680266c
MD5 9f329accebdd3ad3b4415f4aa4791e02
BLAKE2b-256 ed83b673bf5131c61949f7840b70f9d25a52d90d27416fe2692f13ade14496f1

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for django_stubs_ext-5.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6c559214538d6a26f631ca638ddc3251a0a891d607de8ce01d23d3201ad8ad6c
MD5 0f715c3c3c6056f2ea368844b71173b9
BLAKE2b-256 73c15df5231c5db00e3981e71f295c7e5269cbddb0a2c666b3a6f03831b24bd1

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_stubs_ext-5.1.2-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 AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page