Django4中用gettext_lazy配django-stubs遇循环导入与mypy类型推断错误

问题背景 #

在Django 4结合django-stubs开发时，settings模块中使用gettext_lazy会触发mypy循环导入错误：

error:Import cycle from Django settings module prevents type inference for 'LANGUAGES' [misc]

根源是Django 4将gettext_lazy的返回类型从str改为_StrPromise，而django-stubs中_StrPromise的定义文件依赖django.db.models，后者又会导入settings模块，形成循环。当前环境：mypy 1.7、django-stubs 4.2.7、Django 4.2.10。

可行解决方案 #

方案1：用TYPE_CHECKING隔离类型导入

仅在类型检查阶段导入_StrPromise，运行时跳过，打破循环依赖：

from typing import List, Tuple, TYPE_CHECKING
from django.utils.translation import gettext_lazy

if TYPE_CHECKING:
    from django_stubs.utils.functional import _StrPromise

LANGUAGES: List[Tuple[str, '_StrPromise']] = [
    ('en', gettext_lazy('English')),
    ('zh-hans', gettext_lazy('Simplified Chinese')),
]

方案2：用str替代_StrPromise做类型注解

由于_StrPromise是str的子类，运行时完全兼容str的行为，直接用str做注解既能满足mypy检查，又符合Django官方实践：

from typing import List, Tuple
from django.utils.translation import gettext_lazy

LANGUAGES: List[Tuple[str, str]] = [
    ('en', gettext_lazy('English')),
    ('zh-hans', gettext_lazy('Simplified Chinese')),
]

方案3：针对特定行添加mypy忽略

如果不想修改类型注解，仅在LANGUAGES定义行添加忽略注释，不影响整个settings模块的类型检查：

from typing import List, Tuple
from django.utils.translation import gettext_lazy

LANGUAGES = [
    ('en', gettext_lazy('English')),
    ('zh-hans', gettext_lazy('Simplified Chinese')),
]  # type: ignore[misc]

说明 #

以上方案均无需禁用整个settings的类型检查，也不用违背Django官方建议移除gettext_lazy，属于简洁可持续的解决方式。

内容的提问来源于stack exchange，提问作者Charlie