如何将Python TypedDict非必填键转为必填？类型检查问题求助

我定义了一个带可选键的TypedDict，通过if语句在name键缺失（或为空）时抛出异常，确保后续代码执行时该键一定有效，但Pylance无法识别这个逻辑，访问my_dict['name']时会提示类型错误。请问该如何处理？能否为同一个字典重新指定类型？

对应的代码示例：

from typing import TypedDict

output_dict_type = TypedDict(
    'some description',
    {
        'id': str,
        'name': str
    },
    total=False
)
my_dict: output_dict_type = {
    'id': 'foo'
}
if not my_dict.get('name'):
    raise Exception('name is required')

if my_dict['name'] == 'John':  # 报错："name" is not a required key...
    do_stuff()

解决方案 #

1. 用类型断言细化类型 #

可以通过cast给字典重新指定一个要求name必选的TypedDict类型，让类型检查器认可后续的键访问：

from typing import TypedDict, cast

output_dict_type = TypedDict(
    'some description',
    {
        'id': str,
        'name': str
    },
    total=False
)
# 定义一个要求name必选的类型
required_output_type = TypedDict('RequiredOutput', {'id': str, 'name': str})

my_dict: output_dict_type = {
    'id': 'foo'
}
if not my_dict.get('name'):
    raise Exception('name is required')

# 断言字典符合必选类型
my_dict = cast(required_output_type, my_dict)

if my_dict['name'] == 'John':  # 不再报错
    do_stuff()

2. 编写类型守卫函数 #

自定义一个类型守卫，让类型检查器识别经过检查后的字典包含有效name键：

from typing import TypedDict, TypeGuard

output_dict_type = TypedDict(
    'some description',
    {
        'id': str,
        'name': str
    },
    total=False
)

# 类型守卫：返回True时，确认字典包含非空的name键
def has_valid_name(d: output_dict_type) -> TypeGuard[output_dict_type & {'name': str}]:
    return 'name' in d and bool(d['name'])

my_dict: output_dict_type = {
    'id': 'foo'
}
if not has_valid_name(my_dict):
    raise Exception('name is required')

# 这里Pylance会自动识别my_dict包含name键
if my_dict['name'] == 'John':
    do_stuff()

3. 修正检查逻辑 #

原来用my_dict.get('name')会把name为空字符串的情况也判定为缺失，改成同时检查键存在和值非空，类型检查器能直接识别这个逻辑：

from typing import TypedDict

output_dict_type = TypedDict(
    'some description',
    {
        'id': str,
        'name': str
    },
    total=False
)
my_dict: output_dict_type = {
    'id': 'foo'
}
# 先检查键存在，再检查值非空
if 'name' not in my_dict or not my_dict['name']:
    raise Exception('name is required')

# 此时Pylance会知道name键一定存在
if my_dict['name'] == 'John':
    do_stuff()

关于“能否为同一个字典重新指定类型” #

完全可以。通过cast类型断言或者类型守卫，就能给同一个变量赋予更严格的类型约束，后续代码中类型检查器会使用新的类型规则，不再报错。

内容的提问来源于stack exchange，提问作者stkvtflw