如何在TypedDict中实例化大量NotRequired参数？

问题描述 #

我在实际业务中需要处理大量可选参数，基于运行时输入条件填充字典是构建TypedDict最可行的方式，但下面的写法不被类型检查器支持。请问如何在运行时决定NotRequired字段是否存在的前提下，构建包含大量此类字段的TypedDict？我怀疑TypedDict实例中NotRequired字段的存在与否无法在运行时决定。

简化示例代码：

from typing import Mapping, Union, MutableMapping
from typing_extensions import TypedDict, NotRequired


class Pet(TypedDict):
    type: str
    softness: NotRequired[int]
    name: NotRequired[str]

# 重要提示：假设以下变量仅在运行时可知。
softness_exists = False
name_exists = True

optargs: MutableMapping[str, Union[int, str]] = dict()

if softness_exists:
    optargs['softness'] = 999999

if name_exists:
    optargs['name'] = 'David'

p = Pet(
    type='Dog',
    # 类型检查报错：Unsupported type "MutableMapping[str, Union[int, str]]" for ** expansion in TypedDict
    **optargs
)
print(p)

解决方案 #

你这个顾虑是多余的——TypedDict本质就是普通字典，运行时完全可以动态决定NotRequired字段是否存在，问题出在类型检查器无法静态验证你构建的optargs完全符合Pet的类型约束。下面是几种实用的解决方式：

1. 类型断言（最直接）

既然你明确知道运行时optargs的内容完全匹配Pet的可选字段要求，直接把它断言为Pet类型就能绕过类型检查的报错：

p = Pet(
    type='Dog',
    **(optargs as Pet)
)

这种方式简单高效，适合已经确认optargs不会包含非法键或类型的场景。

2. 基础字典更新法（类型安全）

先创建包含必填字段的Pet字典，再用update方法批量添加可选参数，类型检查器能正确识别这种操作的合法性：

p: Pet = {'type': 'Dog'}
if softness_exists:
    p['softness'] = 999999
if name_exists:
    p['name'] = 'David'

如果可选参数数量极多，可以把填充逻辑封装成函数，避免代码冗余：

def fill_pet_options(pet: Pet, softness_exists: bool, name_exists: bool) -> None:
    if softness_exists:
        pet['softness'] = 999999
    if name_exists:
        pet['name'] = 'David'

p: Pet = {'type': 'Dog'}
fill_pet_options(p, softness_exists, name_exists)

3. 拆分TypedDict（进阶）

如果可选参数可以归类，可以把必填和可选字段拆分成两个TypedDict，再合并成完整类型，让类型检查器精准验证optargs：

from typing_extensions import TypedDict, NotRequired

class PetRequired(TypedDict):
    type: str

class PetOptional(TypedDict, total=False):
    softness: int
    name: str

# 合并为完整的Pet类型
class Pet(PetRequired, PetOptional):
    pass

optargs: PetOptional = {}
if softness_exists:
    optargs['softness'] = 999999
if name_exists:
    optargs['name'] = 'David'

p = Pet(type='Dog', **optargs)

这种方式适合参数结构复杂的场景，能最大化保留类型检查的优势。

关键说明 #

TypedDict是静态类型检查工具，运行时它和普通字典没有任何区别——你完全可以在运行时动态添加或删除NotRequired字段，类型检查器的报错只是因为它无法静态证明你的optargs符合要求，并非运行时的限制。

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