Skip to main content
 首页 » 编程设计

python之mypy 是否有子类可接受的返回类型

2024年11月24日8mq0036

我想知道如何(或者目前是否可能)表达函数将返回 mypy 可接受的特定类的子类?

这是一个简单的例子,其中一个基类 Foo由 Bar 继承和 Baz还有一个方便的功能 create()这将返回 Foo 的子类(Bar 或 Baz )取决于指定的参数:

class Foo: 
    pass 
 
 
class Bar(Foo): 
    pass 
 
 
class Baz(Foo): 
    pass 
 
 
def create(kind: str) -> Foo: 
    choices = {'bar': Bar, 'baz': Baz} 
    return choices[kind]() 
 
 
bar: Bar = create('bar') 

当用 mypy 检查此代码时,返回以下错误:

错误:赋值中的类型不兼容(表达式的类型为“Foo”,变量的类型为“Bar”)

有没有办法表明这应该是可接受的/允许的。即create()的预期返回函数不是(或可能不是)Foo 的实例而是它的一个子类?

我在寻找类似的东西:

def create(kind: str) -> typing.Subclass[Foo]: 
    choices = {'bar': Bar, 'baz': Baz} 
    return choices[kind]() 

但这不存在。显然,在这种简单的情况下,我可以这样做:

def create(kind: str) -> typing.Union[Bar, Baz]: 
    choices = {'bar': Bar, 'baz': Baz} 
    return choices[kind]() 

但我正在寻找可以概括为 N 个可能的子类的东西,其中 N 是一个比我想定义为 typing.Union[...] 的数字大的数字。类型。

有人知道如何以一种简单的方式做到这一点吗?


在可能没有简单方法的情况下,我知道有许多不太理想的方法可以规避这个问题:

  1. 概括返回类型:
def create(kind: str) -> typing.Any: 
    ... 

这解决了赋值的类型问题,但是很糟糕,因为它减少了函数签名返回的类型信息。

  1. 忽略错误:
bar: Bar = create('bar')  # type: ignore 

这会抑制 mypy 错误,但这也不理想。我确实喜欢它使 bar: Bar = ... 更加明确是故意的,不仅仅是编码错误,但抑制错误仍然不太理想。

  1. 转换类型:
bar: Bar = typing.cast(Bar, create('bar')) 

与前一个案例一样,这个案例的积极方面是它使 Foo返回Bar分配更明确。如果无法执行我上面的要求,这可能是最好的选择。我认为我厌恶使用它的部分原因是作为包装函数的笨拙(在使用和可读性方面)。可能只是现实,因为类型转换不是语言的一部分 - 例如 create('bar') as Bar , 或 create('bar') astype Bar ,或类似的东西。

请您参考如下方法:

Mypy 并没有提示您定义函数的方式:该部分实际上完全没有错误。

相反,它是在提示您在最后一行的变量赋值中调用函数的方式:

bar: Bar = create('bar') 

由于 create(...) 被注释为返回 Foo 或 foo 的任何子类,因此将其分配给 Bar 类型的变量> 不保证安全。您在这里的选择是删除注释(并接受 bar 类型为 Foo),直接将函数的输出转换为 Bar,或完全重新设计您的代码以避免此问题。


如果你想让mypy明白当你传入字符串"bar"时,create会具体返回一个Bar,你可以sort通过组合 overloads 将其组合在一起和 Literal types .例如。你可以这样做:

from typing import overload 
from typing_extensions import Literal   # You need to pip-install this package 
 
class Foo: pass 
class Bar(Foo): pass 
class Baz(Foo): pass 
 
@overload 
def create(kind: Literal["bar"]) -> Bar: ... 
@overload 
def create(kind: Literal["baz"]) -> Baz: ... 
def create(kind: str) -> Foo: 
    choices = {'bar': Bar, 'baz': Baz} 
    return choices[kind]() 

但就个人而言,我会对过度使用这种模式持谨慎态度——老实说,我认为频繁使用这些类型的类型恶作剧是一种代码味道。此解决方案也不支持对任意数量的子类型进行特殊封装:您必须为每个子类型创建一个重载变体,这可能会变得非常庞大和冗长。