讲师中心 微信公众号
AI工具推荐 视频效率加速

如何在Python项目中使用YAML格式配置文件?

千静君_4522

千静君_4522

发布时间:2026-06-19 08:28:59

|

277人浏览过

|

来源于php中文网

原创

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

如何在python项目中使用yaml格式配置文件?

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,是默认行为,需手动调参。

Claw Code Suite (Python-Only Edition)
Claw Code Suite (Python-Only Edition)

仅使用 Python 将 Claw Code 虚拟化框架与 OpenClaw 集成,提供 184 种工具和 200 多条命令,用于安全分析和代码质量...

下载
  • 加 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 只负责传名字。

立即学习“Python免费学习笔记(深入)”;

  • 配置里写 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() 是安全黑洞
实际项目中最容易被忽略的,是把 YAML 当“万能胶”硬塞逻辑:比如用锚点 &ref 复用复杂结构,结果调试时发现某处改了,另一处没同步;或者把路径拼接、环境判断逻辑全写进 YAML,反而让配置变得不可预测。YAML 应该只承载数据,不动态计算。

热门AI工具

更多
AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

1751

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

4544

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1729

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

26777

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3247

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3247

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

1183

2023.08.11

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

596

2023.08.10

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

40

2026.10.16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn