如何类型提示 Python 函数返回从超类派生的任何类的实例？

Question

我有一堆 Django 模板包含标签，它们将数据库对象的特定实例或 string/int 作为参数，它被解释为该数据库对象的主键。例如...

{% render_product product=obj %}
{% render_product product=42 %}
{% render_product product="42" %}

...一切都工作正常并且做了显而易见的事情：它们使用特定的 Product 实例渲染模板片段，如果需要的话，通过主键从数据库中获取它。这是 Product 和类似类的定义方式：

class Product(models.Model):
    # standard django model definition goes here

以下是此类包含标签中通常会发生的情况：

@register.inclusion_tag("render_product.html")
def render_product(product: Union[Product, str, int] = None) -> dict:
    _product = None
    if isinstance(product, Product):
        _product = product
    elif isinstance(product, str) or isinstance(product, int):
        try:
            _product = Product.objects.get(pk=product)
        except (Product.DoesNotExist, ValueError):
            pass
    return {"product": _product}

由于我在数十个包含标签中出现了相同的模式，因此我尝试将其重构，以便得到类似的内容：

@register.inclusion_tag("render_product.html")
def render_product(product: Union[Product, str, int] = None) -> dict:
    _product = fetch_object(Product, product)
    return {"product": _product}

这是 fetch_object 代码：

def fetch_object(cls: Type[Model] = None, obj: Union[Model, str, int] = None):
    if isinstance(obj, cls):
        return obj
    elif isinstance(obj, str) or isinstance(obj, int):
        try:
            return cls.objects.get(pk=obj)
        except (cls.DoesNotExist, ValueError):
            pass
    return None

我的问题是：我不知道如何指定该函数的返回类型。基本上它应该类似于“任何类的实例，从 Model 或 None 派生”。但如果我尝试类似的事情...

def fetch_object(
    cls: Type[Model] = None, obj: Union[Model, str, int] = None
) -> Union[Model, None]:

...然后，如果我访问所获取对象上的方法（特定于产品，而不是特定于模型），PyCharm 会抱怨“未解析的属性引用”。

我正在尝试在我的Python代码中使用越来越多的类型提示，因为它已经救了我好几次了，但这是其中一种情况，我不知道正确的做法是什么我的谷歌搜索让我失望了。

fetch_object 的正确类型提示是什么？

Answer 1

您在这里要做的就是使您的fetch_object函数成为通用函数。

也就是说，不要只是说您的函数接受任何类型Type[Model]，而是使用类型变量准确捕获您接受的模型类型，并指定输出的确切类型。例如：

from typing import TypeVar

# The bound states that T can be bound to Model or any subclass of Model.
# If the bound keyword argument is omitted, we assume the bound is 'object'.
T = TypeVar('T', bound=Model)

def fetch_object(cls: Type[T] = None, obj: Union[T, str, int] = None) -> Optional[T]:
    if isinstance(obj, cls):
        return obj
    elif isinstance(obj, str) or isinstance(obj, int):
        try:
            return cls.objects.get(pk=obj)
        except (cls.DoesNotExist, ValueError):
            pass
    return None

关于风格约定的一个小注释：为了简洁起见，我选择在这里命名 typevar T。另一个常见的约定是将类型变量命名为 _TModel或 之类的名称_ModelT。也就是说，使用下划线使变量私有，并使用更长的名称以提高可读性。