首页 > 解决方案 > Django 模型子类的类型提示

问题描述

我有 Django 视图的辅助函数,看起来像这样(下面的代码)。它返回 None 或与给定查询匹配的单个对象(例如pk=1)。

from typing import Type, Optional

from django.db.models import Model

def get_or_none(cls: Type[Model], **kwargs) -> Optinal[Model]:
    try:
        return cls.objects.get(**kwargs)
    except cls.DoesNotExist:
        return None

假设我创建了自己的模型(例如Car),并带有自己的字段(例如brandmodel)。当我将get_or_none函数的结果分配给变量,然后检索实例字段时,我在 PyCharm 中收到令人讨厌的未解析引用警告。

car1 = get_or_none(Car, pk=1)

if car1 is not None:
    print(car1.brand) # <- Unresolved attribute reference 'brand' for class 'Model'

什么是提示摆脱此警告并获得变量代码完成的propper类型?

标签: pythondjangopycharmtype-hinting

解决方案


找到几乎类似问题的答案。解决方案是使用TypeVar from typing

from typing import TypeVar, Type, Optional

from django.db.models import Model


T = TypeVar('T', bound=Model)

def get_or_none(cls: Type[T], **kwargs) -> Optional[T]:
    ... # same code

一切正常:没有警告代码完成


推荐阅读