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

Posted 2023-03-22

【中文标题】如何键入提示 Python 函数返回从超类派生的任何类的实例？

【英文标题】：How do I type-hint that a Python function returns instance of any class derived from a superclass?

【发布时间】：2019-04-02 15:07:13

【问题描述】：

我有一堆 Django 模板包含标记，它们将数据库对象的特定实例或字符串/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

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

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

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

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

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

【问题讨论】：

我现在没有时间写一个正确的答案，但你想使用一个 TypeVar。 docs.python.org/3/library/typing.html#typing.TypeVar 为您的参数和返回类型使用相同的 TypeVar，这样 PyCharm 就知道您是否请求产品，您会得到一个产品。

【参考方案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。也就是说，下划线使变量成为私有变量，并且为了便于阅读而使用更长的名称。