9a41aa63ba
* Broaden type annotation for verbose_name(_plural) to accept lazystr. Fixes #1137. Signed-off-by: Zixuan James Li <p359101898@gmail.com> * Broaden type annotation for help_text to accept lazystr. Signed-off-by: Zixuan James Li <p359101898@gmail.com> * Broaden type annotation for ValidationError to accept lazystr. Signed-off-by: Zixuan James Li <p359101898@gmail.com> * Broaden type annotation for label to accept lazystr. Signed-off-by: Zixuan James Li <p359101898@gmail.com> * Add StrPromise and StrOrPromise aliases to django_stubs_ext. We make StrPromise and StrOrPromise available via django_stubs_ext so that conditional imports with TYPE_CHECKING is not required. These aliases fall back to Promise or Union[str, Promise] when not TYPE_CHECKING. Signed-off-by: Zixuan James Li <p359101898@gmail.com> Signed-off-by: Zixuan James Li <p359101898@gmail.com>
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!