Broaden type annotation for verbose_name(_plural) to accept lazystr.

Fixes typeddjango#1137.

Signed-off-by: Zixuan James Li <[email protected]>

Author: PIG208

django-stubs/apps/config.pyi

@@ -3,6 +3,7 @@ from typing import Dict, Iterator, Optional, Type
 
 from django.apps.registry import Apps
 from django.db.models.base import Model
+from django.utils.functional import _StrOrPromise
 
 MODELS_MODULE_NAME: str
 
@@ -11,7 +12,7 @@ class AppConfig:
     module: Optional[types.ModuleType] = ...
     apps: Optional[Apps] = ...
     label: str = ...
-    verbose_name: str = ...
+    verbose_name: _StrOrPromise = ...
     path: str = ...
     models_module: Optional[str] = ...
     models: Dict[str, Type[Model]] = ...

django-stubs/contrib/admin/options.pyi

@@ -41,6 +41,7 @@ from django.http.response import HttpResponse, HttpResponseRedirect, JsonRespons
 from django.template.response import _TemplateForResponseT
 from django.urls.resolvers import URLPattern
 from django.utils.datastructures import _ListOrTuple
+from django.utils.functional import _StrOrPromise
 from django.utils.safestring import SafeString
 from typing_extensions import Literal, TypedDict
 
@@ -296,8 +297,8 @@ class InlineModelAdmin(Generic[_ChildModelT, _ParentModelT], BaseModelAdmin[_Chi
     min_num: Optional[int] = ...
     max_num: Optional[int] = ...
     template: str = ...
-    verbose_name: Optional[str] = ...
-    verbose_name_plural: Optional[str] = ...
+    verbose_name: Optional[_StrOrPromise] = ...
+    verbose_name_plural: Optional[_StrOrPromise] = ...
     can_delete: bool = ...
     show_change_link: bool = ...
     classes: Optional[Sequence[str]] = ...

django-stubs/contrib/admin/widgets.pyi

@@ -7,12 +7,17 @@ from django.db.models.fields import _FieldChoices
 from django.db.models.fields.reverse_related import ForeignObjectRel, ManyToManyRel, ManyToOneRel
 from django.forms.models import ModelChoiceIterator
 from django.forms.widgets import Media, _OptAttrs
+from django.utils.functional import _StrOrPromise
 
 class FilteredSelectMultiple(forms.SelectMultiple):
-    verbose_name: str = ...
+    verbose_name: _StrOrPromise = ...
     is_stacked: bool = ...
     def __init__(
-        self, verbose_name: str, is_stacked: bool, attrs: Optional[_OptAttrs] = ..., choices: _FieldChoices = ...
+        self,
+        verbose_name: _StrOrPromise,
+        is_stacked: bool,
+        attrs: Optional[_OptAttrs] = ...,
+        choices: _FieldChoices = ...,
     ) -> None: ...
 
 class AdminDateWidget(forms.DateInput):

django-stubs/contrib/gis/db/models/fields.pyi

@@ -2,6 +2,7 @@ from typing import Any, Iterable, NamedTuple, Optional, Tuple, TypeVar, Union
 
 from django.core.validators import _ValidatorCallable
 from django.db.models.fields import Field, _ErrorMessagesT, _FieldChoices
+from django.utils.functional import _StrOrPromise
 
 # __set__ value type
 _ST = TypeVar("_ST")
@@ -19,7 +20,7 @@ def get_srid_info(srid: int, connection: Any) -> SRIDCacheEntry: ...
 class BaseSpatialField(Field[_ST, _GT]):
     def __init__(
         self,
-        verbose_name: Optional[Union[str, bytes]] = ...,
+        verbose_name: Optional[Union[_StrOrPromise, bytes]] = ...,
         srid: int = ...,
         spatial_index: bool = ...,
         *,
@@ -65,7 +66,7 @@ class GeometryField(BaseSpatialField):
     geography: Any = ...
     def __init__(
         self,
-        verbose_name: Optional[Union[str, bytes]] = ...,
+        verbose_name: Optional[Union[_StrOrPromise, bytes]] = ...,
         dim: int = ...,
         geography: bool = ...,
         *,

django-stubs/core/cache/backends/db.pyi

@@ -1,13 +1,14 @@
 from typing import Any, Dict
 
 from django.core.cache.backends.base import BaseCache
+from django.utils.functional import _StrOrPromise
 
 class Options:
     db_table: str = ...
     app_label: str = ...
     model_name: str = ...
-    verbose_name: str = ...
-    verbose_name_plural: str = ...
+    verbose_name: _StrOrPromise = ...
+    verbose_name_plural: _StrOrPromise = ...
     object_name: str = ...
     abstract: bool = ...
     managed: bool = ...

django-stubs/db/models/fields/__init__.pyi

@@ -30,7 +30,7 @@ from django.db.models.query_utils import Q, RegisterLookupMixin
 from django.forms import Field as FormField
 from django.forms import Widget
 from django.utils.datastructures import DictWrapper
-from django.utils.functional import _Getter
+from django.utils.functional import _Getter, _StrOrPromise
 from typing_extensions import Protocol
 
 class Empty: ...
@@ -134,7 +134,7 @@ class Field(RegisterLookupMixin, Generic[_ST, _GT]):
     max_length: Optional[int]
     model: Type[Model]
     name: str
-    verbose_name: str
+    verbose_name: _StrOrPromise
     description: Union[str, _Getter[str]]
     blank: bool
     null: bool
@@ -158,7 +158,7 @@ class Field(RegisterLookupMixin, Generic[_ST, _GT]):
     non_db_attrs: Tuple[str, ...]
     def __init__(
         self,
-        verbose_name: Optional[str] = ...,
+        verbose_name: Optional[_StrOrPromise] = ...,
         name: Optional[str] = ...,
         primary_key: bool = ...,
         max_length: Optional[int] = ...,
@@ -260,7 +260,7 @@ class DecimalField(Field[_ST, _GT]):
     decimal_places: int = ...
     def __init__(
         self,
-        verbose_name: Optional[str] = ...,
+        verbose_name: Optional[_StrOrPromise] = ...,
         name: Optional[str] = ...,
         max_digits: Optional[int] = ...,
         decimal_places: Optional[int] = ...,
@@ -289,7 +289,7 @@ class CharField(Field[_ST, _GT]):
     _pyi_lookup_exact_type: Any
     def __init__(
         self,
-        verbose_name: Optional[str] = ...,
+        verbose_name: Optional[_StrOrPromise] = ...,
         name: Optional[str] = ...,
         primary_key: bool = ...,
         max_length: Optional[int] = ...,
@@ -319,7 +319,7 @@ class CommaSeparatedIntegerField(CharField[_ST, _GT]): ...
 class SlugField(CharField[_ST, _GT]):
     def __init__(
         self,
-        verbose_name: Optional[str] = ...,
+        verbose_name: Optional[_StrOrPromise] = ...,
         name: Optional[str] = ...,
         primary_key: bool = ...,
         unique: bool = ...,
@@ -349,7 +349,7 @@ class EmailField(CharField[_ST, _GT]): ...
 class URLField(CharField[_ST, _GT]):
     def __init__(
         self,
-        verbose_name: Optional[str] = ...,
+        verbose_name: Optional[_StrOrPromise] = ...,
         name: Optional[str] = ...,
         *,
         primary_key: bool = ...,
@@ -381,7 +381,7 @@ class TextField(Field[_ST, _GT]):
     _pyi_lookup_exact_type: Any
     def __init__(
         self,
-        verbose_name: Optional[str] = ...,
+        verbose_name: Optional[_StrOrPromise] = ...,
         name: Optional[str] = ...,
         primary_key: bool = ...,
         max_length: Optional[int] = ...,
@@ -458,7 +458,7 @@ class DateField(DateTimeCheckMixin, Field[_ST, _GT]):
     _pyi_lookup_exact_type: Union[str, date]
     def __init__(
         self,
-        verbose_name: Optional[str] = ...,
+        verbose_name: Optional[_StrOrPromise] = ...,
         name: Optional[str] = ...,
         auto_now: bool = ...,
         auto_now_add: bool = ...,
@@ -486,7 +486,7 @@ class TimeField(DateTimeCheckMixin, Field[_ST, _GT]):
     _pyi_private_get_type: time
     def __init__(
         self,
-        verbose_name: Optional[str] = ...,
+        verbose_name: Optional[_StrOrPromise] = ...,
         name: Optional[str] = ...,
         auto_now: bool = ...,
         auto_now_add: bool = ...,
@@ -518,7 +518,7 @@ class UUIDField(Field[_ST, _GT]):
     _pyi_private_get_type: uuid.UUID
     def __init__(
         self,
-        verbose_name: Optional[str] = ...,
+        verbose_name: Optional[_StrOrPromise] = ...,
         *,
         name: Optional[str] = ...,
         primary_key: bool = ...,
@@ -551,7 +551,7 @@ class FilePathField(Field[_ST, _GT]):
     allow_folders: bool = ...
     def __init__(
         self,
-        verbose_name: Optional[str] = ...,
+        verbose_name: Optional[_StrOrPromise] = ...,
         name: Optional[str] = ...,
         path: Union[str, Callable[..., str]] = ...,
         match: Optional[str] = ...,

django-stubs/db/models/fields/files.pyi

@@ -8,6 +8,7 @@ from django.db.models.base import Model
 from django.db.models.fields import Field, _ErrorMessagesT, _FieldChoices
 from django.db.models.query_utils import DeferredAttribute
 from django.utils._os import _PathCompatible
+from django.utils.functional import _StrOrPromise
 from typing_extensions import Protocol
 
 class FieldFile(File):
@@ -46,7 +47,7 @@ class FileField(Field):
     upload_to: Union[_PathCompatible, _UploadToCallable] = ...
     def __init__(
         self,
-        verbose_name: Optional[str] = ...,
+        verbose_name: Optional[_StrOrPromise] = ...,
         name: Optional[str] = ...,
         upload_to: Union[_PathCompatible, _UploadToCallable] = ...,
         storage: Optional[Union[Storage, Callable[[], Storage]]] = ...,
@@ -92,7 +93,7 @@ class ImageFieldFile(ImageFile, FieldFile):
 class ImageField(FileField):
     def __init__(
         self,
-        verbose_name: Optional[str] = ...,
+        verbose_name: Optional[_StrOrPromise] = ...,
         name: Optional[str] = ...,
         width_field: Optional[str] = ...,
         height_field: Optional[str] = ...,

django-stubs/db/models/fields/json.pyi

@@ -5,6 +5,7 @@ from django.db.backends.base.base import BaseDatabaseWrapper
 from django.db.models import lookups
 from django.db.models.lookups import PostgresOperatorLookup, Transform
 from django.db.models.sql.compiler import SQLCompiler
+from django.utils.functional import _StrOrPromise
 
 from . import Field
 from .mixins import CheckFieldDefaultMixin
@@ -14,7 +15,7 @@ class JSONField(CheckFieldDefaultMixin, Field):
     decoder: Optional[Type[json.JSONDecoder]]
     def __init__(
         self,
-        verbose_name: Optional[str] = ...,
+        verbose_name: Optional[_StrOrPromise] = ...,
         name: Optional[str] = ...,
         encoder: Optional[Type[json.JSONEncoder]] = ...,
         decoder: Optional[Type[json.JSONDecoder]] = ...,

django-stubs/db/models/fields/related.pyi

@@ -20,6 +20,7 @@ from django.db.models.fields.reverse_related import ManyToOneRel as ManyToOneRel
 from django.db.models.fields.reverse_related import OneToOneRel as OneToOneRel
 from django.db.models.manager import RelatedManager
 from django.db.models.query_utils import FilteredRelation, PathInfo, Q
+from django.utils.functional import _StrOrPromise
 from typing_extensions import Literal
 
 _T = TypeVar("_T", bound=models.Model)
@@ -75,7 +76,7 @@ class ForeignObject(RelatedField[_ST, _GT]):
         swappable: bool = ...,
         *,
         db_constraint: bool = ...,
-        verbose_name: Optional[str] = ...,
+        verbose_name: Optional[_StrOrPromise] = ...,
         name: Optional[str] = ...,
         primary_key: bool = ...,
         unique: bool = ...,
@@ -120,7 +121,7 @@ class ForeignKey(ForeignObject[_ST, _GT]):
         to_field: Optional[str] = ...,
         db_constraint: bool = ...,
         *,
-        verbose_name: Optional[Union[str, bytes]] = ...,
+        verbose_name: Optional[Union[_StrOrPromise, bytes]] = ...,
         name: Optional[str] = ...,
         primary_key: bool = ...,
         max_length: Optional[int] = ...,
@@ -169,7 +170,7 @@ class OneToOneField(ForeignKey[_ST, _GT]):
         limit_choices_to: Optional[_AllLimitChoicesTo] = ...,
         parent_link: bool = ...,
         db_constraint: bool = ...,
-        verbose_name: Optional[Union[str, bytes]] = ...,
+        verbose_name: Optional[Union[_StrOrPromise, bytes]] = ...,
         name: Optional[str] = ...,
         primary_key: bool = ...,
         max_length: Optional[int] = ...,
@@ -229,7 +230,7 @@ class ManyToManyField(RelatedField[_ST, _GT]):
         db_table: Optional[str] = ...,
         swappable: bool = ...,
         *,
-        verbose_name: Optional[Union[str, bytes]] = ...,
+        verbose_name: Optional[Union[_StrOrPromise, bytes]] = ...,
         name: Optional[str] = ...,
         primary_key: bool = ...,
         max_length: Optional[int] = ...,

django-stubs/db/models/options.pyi

@@ -12,6 +12,7 @@ from django.db.models.fields.reverse_related import ForeignObjectRel
 from django.db.models.manager import Manager
 from django.db.models.query_utils import PathInfo
 from django.utils.datastructures import ImmutableList, _ListOrTuple
+from django.utils.functional import _StrOrPromise
 from typing_extensions import Literal
 
 PROXY_PARENTS: object
@@ -46,8 +47,8 @@ class Options(Generic[_M]):
     base_manager_name: Optional[str] = ...
     default_manager_name: Optional[str] = ...
     model_name: Optional[str] = ...
-    verbose_name: Optional[str] = ...
-    verbose_name_plural: Optional[str] = ...
+    verbose_name: Optional[_StrOrPromise] = ...
+    verbose_name_plural: Optional[_StrOrPromise] = ...
     db_table: str = ...
     ordering: Optional[Sequence[str]] = ...
     indexes: List[Any] = ...

django-stubs/utils/functional.pyi

@@ -43,6 +43,7 @@ class _StrPromise(Promise, Sequence[str]):
     # Mypy requires this for the attribute hook to take effect
     def __getattribute__(self, __name: str) -> Any: ...
 
+_StrOrPromise = Union[str, _StrPromise]
 _C = TypeVar("_C", bound=Callable)
 
 def lazy(func: _C, *resultclasses: Any) -> _C: ...