mypy 无法识别字典字典

时间:2021-07-08 16:03:05

标签: python dictionary type-hinting mypy type-annotation

我正在尝试使用 mypy 检查我的类型注释,但此错误不断发生:

Script.py:201: error: Item "Dict[str, Union[float, int]]" of "Union[Dict[str, Union[float, int]], str, float, int, bool]" has no 
attribute "endswith"

我的代码如下:

from typing import Counter, Dict, Iterable, List, NoReturn, Optional, Set, Tuple, Union

TYPE_NUMBER         = Union[float, int]
TYPE_CONFIGURATION  = Dict[str, Union[Dict[str, TYPE_NUMBER], str, float, int, bool]]

def check_configuration(config: TYPE_CONFIGURATION) -> Union[bool, NoReturn]:
    database = 'database'
    assert isinstance(config[database], str)
    assert config[database].endswith('.prdb')

它正常调用python运行得很好。所以我知道 config[database1] 的结果实际上是一个字符串。问题是我的类型别名:

TYPE_CONFIGURATION = Dict[str, Union[Dict[str, TYPE_NUMBER], str, float, int, bool]]

还是它是一个错误?

config 是从 JSON 文件加载的 dict,其中唯一的 可选 参数是 "start"。 JSON 文件如下所示:

{
    "database" : "bla/bla/bla/file.csv",
    "distance" : 800,
    "t"        : false,
    "output"   : "bla/bla/bla/file-out.csv",

    "start"    : {"1": 1343.786, "2": 1356.523}
}

1 个答案:

答案 0 :(得分:0)

如果您知道 "start" 中的 config 键将始终具有 Dict[str, Union[int, float]] 类型的值,那么一种解决方案可能是在您的类型注释中使用 TypedDictTypedDict 允许您指定与每个键关联的值的预期类型。在下面的示例中,我指定了 total=False,让 mypy 知道即使字典不包含所有字段,它仍然可以被视为 ConfigDict在类型定义中指定(您提到 "start" 是可选参数)。

from typing import Dict, Union, TypedDict, NoReturn
    
TYPE_NUMBER = Union[float, int]
    
class ConfigDict(TypedDict, total=False):
    database: str
    distance: int
    t: bool
    start: Dict[str, TYPE_NUMBER]
    
def check_configuration(config: ConfigDict) -> Union[bool, NoReturn]:
    assert isinstance(config['database'], str)
    assert config['database'].endswith('.prdb')
    return True

TypedDict 的子类实际上不是类型,它们只是带有一些附加信息的字典,以便类型检查器使用。所以你可以像这样实例化它们:

config = ConfigDict(
    database="bla/bla/bla/file.csv",
    distance=800,
    t=False,
    output="bla/bla/bla/file-out.csv",
    start={"1": 1343.786, "2": 1356.523}
)

或者像这样:

config: ConfigDict = {
    "database" : "bla/bla/bla/file.csv",
    "distance" : 800,
    "t"        : False,
    "output"   : "bla/bla/bla/file-out.csv",

    "start"    : {"1": 1343.786, "2": 1356.523}
}

——这两种语法在它们产生的结果中是相同的,对于它们,type(config) 将是 dict 而不是 ConfigDictTypedDict({{1 }} 不 工作)。

我同意 @MarcelWilson 的评论,即 Mypy error on dict of dict: Value of type "object" is not indexable 在这里与您的问题的原因相关。