您可以在Python类型注释中指定差异吗?

时间:2019-03-14 04:10:58

标签: python covariance typing mypy

您能在下面的代码中发现错误吗? Mypy不能。

from typing import Dict, Any

def add_items(d: Dict[str, Any]) -> None:
    d['foo'] = 5

d: Dict[str, str] = {}
add_items(d)

for key, value in d.items():
    print(f"{repr(key)}: {repr(value.lower())}")

Python当然可以发现错误,可以帮助我们通知'int' object has no attribute 'lower'。太糟糕了,要等到运行时才能告诉我们。

据我所知,mypy不会捕获此错误,因为它允许d的{​​{1}}参数的参数是协变的。如果我们仅从字典中阅读,那将是有道理的。如果仅阅读,那么我们希望参数是协变的。如果我们准备读取任何类型,那么我们应该能够读取字符串类型。当然,如果我们只是阅读,则应将其键入为add_items

自编写以来,我们实际上希望参数为 contravariant 。例如,对于某人来说,通过typing.Mapping是很有意义的,因为这样可以完全存储字符串键和整数值。

如果我们正在阅读文字,那么除了参数不变之外别无选择。

是否可以指定我们需要哪种差异?更好的是,mypy是否足够复杂,以至于可以期望它可以通过静态分析确定方差,并且应该将其记录为错误?还是Python中类型检查的当前状态根本无法捕获这种编程错误?

1 个答案:

答案 0 :(得分:1)

您的分析不正确-实际上与方差无关,而且mypy中的Dict类型实际上是不变的。达到其价值。

问题是,您已将Dict的值声明为'Datatables' => Yajra\DataTables\Facades\DataTables::class, 类型,即动态类型。这实际上意味着您希望mypy基本上不对与Dict值相关的任何内容进行类型检查。而且由于您选择不进行类型检查,因此自然不会出现任何与类型相关的错误。

(这是通过神奇地将Any放置在类型晶格的顶部和底部来实现的。基本上,给定某种类型Any的情况下,T始终是子类型T 的T始终是Any的子类型。Mypy自动选择任何关系而不会出错。)

通过运行以下程序,您可以看到Dict对您而言是不变的:

Any

只有对from typing import Dict class A: pass class B(A): pass class C(B): pass def accepts_a(x: Dict[str, A]) -> None: pass def accepts_b(x: Dict[str, B]) -> None: pass def accepts_c(x: Dict[str, C]) -> None: pass my_dict: Dict[str, B] = {"foo": B()} # error: Argument 1 to "accepts_a" has incompatible type "Dict[str, B]"; expected "Dict[str, A]" # note: "Dict" is invariant -- see http://mypy.readthedocs.io/en/latest/common_issues.html#variance # note: Consider using "Mapping" instead, which is covariant in the value type accepts_a(my_dict) # Type checks! No error. accepts_b(my_dict) # error: Argument 1 to "accepts_c" has incompatible type "Dict[str, B]"; expected "Dict[str, C]" accepts_c(my_dict) 的调用成功,这与期望的方差一致。


要回答有关如何设置方差的问题-mypy的设计使数据结构的方差在定义时设置,而不能在调用时真正更改。

因此,由于Dict被定义为不变的,因此事后您无法真正将其更改为协变或不变的。

有关在定义时设置方差的更多详细信息,请参见mypy reference docs on generics

如您所指出的,您可以声明要使用“映射”来接受Dict的只读版本。通常情况下,您可能要使用任何PEP 484数据结构的只读版本-例如Sequence是List的只读版本。

AFAIK虽然没有默认的仅写版本的Dict。但是,您可以使用protocols(一种有望很快成为标准化的方法来进行结构化而不是名义上的输入)来自己捣乱:

accept_b

要回答您的隐式问题(“如何让mypy在此处检测类型错误/正确键入代码以检查我的代码?”),答案是“简单”-避免不惜一切代价使用from typing import Dict, TypeVar, Generic from typing_extensions import Protocol K = TypeVar('K', contravariant=True) V = TypeVar('V', contravariant=True) # Mypy requires the key to also be contravariant. I suspect this is because # it cannot actually verify all types that satisfy the WriteOnlyDict # protocol will use the key in an invariant way. class WriteOnlyDict(Protocol, Generic[K, V]): def __setitem__(self, key: K, value: V) -> None: ... class A: pass class B(A): pass class C(B): pass # All three functions accept only objects that implement the # __setitem__ method with the signature described in the protocol. # # You can also use only this method inside of the function bodies, # enforcing the write-only nature. def accepts_a(x: WriteOnlyDict[str, A]) -> None: pass def accepts_b(x: WriteOnlyDict[str, B]) -> None: pass def accepts_c(x: WriteOnlyDict[str, C]) -> None: pass my_dict: WriteOnlyDict[str, B] = {"foo": B()} # error: Argument 1 to "accepts_a" has incompatible type "WriteOnlyDict[str, B]"; expected "WriteOnlyDict[str, A]" accepts_a(my_dict) # Both type-checks accepts_b(my_dict) accepts_c(my_dict) 。每次这样做,都是有意在类型系统中打开一个孔。

例如,使用Any可以更可靠地声明dict的值可以是任何值。现在,mypy会将对Dict[str, object]函数的调用标记为非类型安全的。

或者,如果您知道自己的值将是异类的,请考虑使用TypedDict

通过启用Disable dynamic typing系列命令行标志/配置文件标志,甚至可以使mypy禁止使用Any。

也就是说,实际上,完全禁止使用Any通常是不现实的。即使您可以在代码中达到这一理想,许多第3方库也可以是未注释的或未完全注释的,这意味着它们可以在任何地方使用Any。因此,不幸的是,完全删除它们的使用往往会导致需要大量额外的工作。