您可以在下面的代码中发现错误吗?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不会捕获此错误,因为它允许参数to的d
参数add_items
是协变的。如果我们仅从字典中读取内容,那将是有道理的。如果仅阅读,那么我们希望参数是协变的。如果我们准备读取任何类型,那么我们应该能够读取字符串类型。当然,如果我们只是在阅读,则应将其键入为typing.Mapping
。
既然我们正在写,我们实际上希望参数是反变的。例如,对于某人来说,传入Dict[Any, Any]
将会是很有意义的,因为那将完全能够存储字符串键和整数值。
如果我们阅读和写作,就没有选择,但对于参数是不变的。
有没有一种方法可以指定我们需要什么样的差异?更好的是,mypy是否足够复杂,以至于可以期望它可以通过静态分析确定方差,并且应该将其记录为错误?还是Python中类型检查的当前状态根本无法捕获这种编程错误?
您的分析是错误的-实际上这与方差无关,而且mypy中的Dict类型实际上与其值无关。
相反,问题在于您已将Dict的值声明为type Any
,即dynamic类型。这实际上意味着您希望mypy基本上不对与Dict值相关的任何内容进行类型检查。并且由于您选择不进行类型检查,因此自然不会出现任何与类型相关的错误。
(这是通过魔术地放置Any
在类型晶格的顶部和底部来实现的。基本上,对于某些类型T
,Any
通常是T的子类型,而T始终是T的子类型Any
。Mypy自动选择任何关系结果没有错误。)
通过运行以下程序,您可以看到Dict对您来说是不变的:
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)
仅调用accept_b
成功,这与预期的差异一致。
为了回答有关如何设置方差的问题-mypy的设计使数据结构的方差在定义时设置,而不能在调用时真正更改。
因此,由于Dict被定义为不变的,因此事后您无法真正将其更改为协变或不变的。
有关在定义时设置方差的更多详细信息,请参见有关泛型的mypy参考文档。
如您所指出的,您可以使用Mapping声明要接受Dict的只读版本。通常,您可能要使用任何PEP 484数据结构的只读版本-例如,Sequence是List的只读版本。
AFAIK虽然没有默认的仅写版本的Dict。但是,您可以使用协议(一种有望很快成为标准化的方法来进行结构化而不是名义上的键入)来自己捣乱:
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)
要回答您的隐式问题(“如何让mypy在此处检测类型错误/正确地检查我的代码?”),答案是“简单”-避免Any
不惜一切代价使用。每次这样做,您都在刻意在类型系统中打个洞。
例如,一种更加类型安全的方式来声明dict的值可以是任何值Dict[str, object]
。现在,mypy将标记该add_items
函数调用为非类型安全的。
或者,如果您知道您的值将是异构的,请考虑使用TypedDict。
您甚至可以通过启用“禁用动态类型的命令行标志/配置文件标志”系列来使mypy禁止“ Any”的某些用法。
也就是说,实际上,完全禁止使用Any通常是不现实的。即使您可以在代码中达到这一理想,许多第3方库也可以是未注释的或未完全注释的,这意味着它们可以在任何地方使用Any。因此,不幸的是,完全删除它们的使用往往会导致需要大量额外的工作。
本文收集自互联网,转载请注明来源。
如有侵权,请联系 [email protected] 删除。
我来说两句