yaml.safe_load()是唯一推荐的读取方式,因yaml.load()存在远程代码执行风险;scannererror或parsererror绝大多数由缩进错误(如tab键、冒号后缺空格)或特殊字符未引号包裹等基础语法问题引发,而非逻辑错误。

yaml.safe_load() 是唯一推荐的读取方式,yaml.load() 有远程代码执行风险,必须禁用。
读配置时为什么总报 ScannerError 或 ParserError
绝大多数是缩进或字符问题,不是语法逻辑错。YAML 对空格极其敏感,Tab 键、冒号后缺空格、行尾多余空格都会触发解析失败。
- 用编辑器开启“显示空白字符”功能,确认所有缩进都是空格(推荐 2 个),绝不能混入 Tab
-
key: value中冒号后必须至少一个空格,host:localhost会报错,正确写法是host: localhost - 布尔值在 PyYAML 5.x+ 中只认小写
true/false,写True或TRUE会被当字符串处理 - 含
:、{、[等字符的字符串建议加引号,比如url: "https://api.example.com/v1/"
PyYAML 和 ruamel.yaml 到底选哪个
看你要不要保留注释和格式。如果只是读写参数、不关心配置文件长什么样,PyYAML 足够;如果要支持 YAML 1.2、修改后仍保持原有注释/引号/换行,必须用 ruamel.yaml。
-
PyYAML:安装快、轻量,safe_load()和safe_dump()能满足 90% 场景 -
ruamel.yaml:默认保留注释,支持round_trip_load(),但写法稍复杂,比如要显式设置yaml.preserve_quotes = True - 别混用:同一项目中不要同时 import
yaml和ruamel.yaml,容易因类型冲突导致TypeError
写配置时 safe_dump() 输出太紧凑怎么办
默认输出是单行嵌套、无换行、无缩进,可读性差。这不是 bug,是默认行为,需手动调参。
- 加
default_flow_style=False让字典和列表展开为多行结构 - 加
indent=2控制缩进宽度(注意:PyYAML 5.1+ 才支持该参数) - 加
allow_unicode=True避免中文被转成\u4f60\u597d这种编码 - 示例:
yaml.safe_dump(config, f, default_flow_style=False, indent=2, allow_unicode=True)
动态加载类或函数时 YAML 里怎么写类型名
YAML 本身不执行代码,它只提供字符串。真正做映射的是你写的注册器或工厂函数,YAML 只负责传名字。
- 配置里写
type: "Conv2d",代码里用model_registry.get("Conv2d")拿到类 - 不要在 YAML 里写
type: __main__.CustomConv2d—— 这样耦合太死,且跨模块会失效 - 参数部分保持纯数据,如
params: {in_channels: 3, out_channels: 64},由 Python 侧用**config["params"]解包传参 - 避免在 YAML 中嵌入 Python 表达式(如
!eval),safe_load()本来就不支持,强行用load()是安全黑洞
&ref 复用复杂结构,结果调试时发现某处改了,另一处没同步;或者把路径拼接、环境判断逻辑全写进 YAML,反而让配置变得不可预测。YAML 应该只承载数据,不动态计算。Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!











