Monkey-patching and extensions for django-stubs
Project description
Extensions and monkey-patching for django-stubs
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!
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file django_stubs_ext-5.0.3.tar.gz.
File metadata
- Download URL: django_stubs_ext-5.0.3.tar.gz
- Upload date:
- Size: 9.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cd361f5b951c6abdf867c55d247541f0609d1e8334ccb09c7a12910111425234 |
|
| MD5 | 1fe8f964e316c2171024b99f7b8505fc |
|
| BLAKE2b-256 | 5141426a00e781bc9df466100662a0ddb024f3be7025c2e75a9c3674b154369e |
File details
Details for the file django_stubs_ext-5.0.3-py3-none-any.whl.
File metadata
- Download URL: django_stubs_ext-5.0.3-py3-none-any.whl
- Upload date:
- Size: 9.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cc7a0026367baa5cdfc72cf8855e2e14d75dd5a35bd11e7d3086dc9d7f94d169 |
|
| MD5 | 6f680a749f932d6995df244bff83fdb9 |
|
| BLAKE2b-256 | 22403d224256444e984c3e25c084cd275485a4ababcac8495bc4afa160b9d791 |
