Question

我有一堆Django模板包含标签，这些标签以一个数据库对象的特定实例或一个字符串/整数作为参数，这被解释为该数据库对象的主键。例如...

{% 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代码中使用越来越多的类型提示，因为它已经保存了我的屁股几次，但这是其中一种，我不知道该怎么做才是正确的那样的话，我的Google-fu使我失败了。

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

Answer 1

您要在此处执行的操作是将fetch_object函数设为generic function。

也就是说，不是仅仅说您的函数接受任何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。另一个常见的约定是将您的typevar命名为_TModel或_ModelT。也就是说，将变量设置为私有的下划线，以及为了可读性而更长的名称。

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

1 个答案: