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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: django_stubs_ext-5.1.0.tar.gz
  • Upload date:
  • Size: 9.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for django_stubs_ext-5.1.0.tar.gz
Algorithm Hash digest
SHA256 ed7d51c0b731651879fc75f331fb0806d98b67bfab464e96e2724db6b46ef926
MD5 f8e899ca63ce36de06363d8a0b6435c3
BLAKE2b-256 60a5dfb120bf3ce1f0da109481605f704ffe72533f056f42e8cffd5a486504a7

See more details on using hashes here.

File details

Details for the file django_stubs_ext-5.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_stubs_ext-5.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a455fc222c90b30b29ad8c53319559f5b54a99b4197205ddbb385aede03b395d
MD5 cf4aa4fa084adeec3f5f1bcd8e60677b
BLAKE2b-256 eb0320a5a19d1b8d26eddd8420261304ee9e6accd802f5332e360daaa2202afb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page