Python 字典取值报 KeyError:get、setdefault 与 in 判断分别适合什么场景

AI智能摘要
配置中少一个键,脚本可能因KeyError中断,但这未必是字典损坏,而可能是缺失项没被处理。get适合只读取临时兜底值,不会写回字典;setdefault会在键不存在时把默认值补进原字典;若缺键代表配置不完整,则应先用in校验并抛出明确错误。多层字典更棘手:外层get成功,内层键缺失仍会报KeyError。面对不确定配置,怎样按用途选对方法?
— 此摘要由AI分析文章内容生成,仅供参考。

脚本读取配置时,如果直接写 config["timeout"],而字典里没有 "timeout" 这个键,Python 就会抛出 KeyError。这不一定意味着字典坏了:也可能只是配置项未填写,但程序没有处理缺失情况。

处理方式取决于这个键的用途:只是读取时需要一个备用值,还是希望把默认值写回字典,或者缺少该键就应该提前报错?get、setdefault 和 in 分别适合这三类情况。

只读取备用值:使用 get

假设配置中没有设置超时时间,但脚本可以使用默认值:

config = {"host": "localhost"}

timeout = config.get("timeout", 30)

print(timeout)  # 30
print(config)   # {'host': 'localhost'}

get 在键存在时返回对应的值;键不存在时返回指定的默认值。它不会把默认值写入原字典。如果不传默认值,缺少键时会返回 None。

要留意,get 只判断键是否存在,不判断已有值是否合适。例如,"timeout" 存在但值为 None 时,config.get("timeout", 30) 返回的仍是 None,而不是 30。如果后续计算要求数值,还需要另行检查。

需要补入默认值:使用 setdefault

如果希望缺少配置项时,不仅得到默认值,还要让后续代码也能从字典中读到它,可以使用 setdefault:

config = {"host": "localhost"}

timeout = config.setdefault("timeout", 30)

print(timeout)  # 30
print(config)   # {'host': 'localhost', 'timeout': 30}

键不存在时,setdefault 会把键和默认值加入原字典,并返回该默认值;键已存在时,它返回原来的值,不会用默认值覆盖。和 get 一样,已有值即使是 None,也不会因此被替换。

这个区别对统计数据也很有用:需要先为某个统计项建立初始值,再更新它时,setdefault 可以完成初始化。但如果只是临时读取,使用 get 更直接,也不会意外改变传入的字典。

必填项先校验:使用 in 判断

有些配置不适合悄悄使用默认值。例如,脚本必须知道要连接哪个主机,此时应先检查键是否存在,再决定如何提示:

config = {"timeout": 30}

if "host" not in config:
    raise ValueError("缺少必填配置:host")

host = config["host"]

"host" in config 返回布尔值:键存在时为 True,不存在时为 False。判断本身不会修改字典,也不会返回该键对应的值;确认存在后,代码才读取它。

提前校验能让错误信息更贴近问题,而不是让程序在后续某处才抛出 KeyError。不过,键存在不代表值一定有效:如果空字符串或 None 不符合要求,还要继续检查对应的值。

嵌套字典不能只检查第一层

配置采用多层字典时,外层读取成功,并不代表内层键也存在。例如:

config = {"server": {}}

port = config.get("server", {})["port"]  # 仍会抛出 KeyError

这里 get 只处理了外层 "server" 缺失的情况。由于 "server" 存在,它返回空字典;随后直接读取 ["port"],仍会因为键不存在而报错。

如果端口允许使用默认值,可以逐层读取:

config = {"server": {}}

server = config.get("server", {})
port = server.get("port", 8000)

print(port)  # 8000

这段写法假设 "server" 存在时,其值也是字典。如果它的值是 None 或其他没有 get 方法的对象,第二次调用仍会报错。面对来源不确定的配置,应先检查外层值的类型;若内层键是必填项,也应检查它是否存在,而不是直接套用默认值。

实际选择时,可以先问自己:这个值只是读取时临时兜底吗?是就用 get;如果默认值需要留在字典中,考虑 setdefault;如果缺少该键意味着配置不完整,就先用 in 校验并给出明确提示。这样处理的重点不是消除报错,而是让缺失配置时的行为符合脚本的预期。

© 版权声明
THE END
喜欢就支持一下吧
点赞6 分享