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

Question

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

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

所有这些都很好，而且做得很明显：它们使用特定的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。另一个常见的约定是将typevar命名为_TModel或_ModelT。也就是说，使用下划线使变量成为私有变量，并使用更长的名称以提高可读性。