0

0

PythonYAML配置文件读写方法_pyyaml实战讲解【指导】

冷漠man

冷漠man

发布时间:2025-12-23 22:54:02

|

346人浏览过

|

来源于php中文网

原创

python读写yaml配置文件应使用pyyaml库,推荐用yaml.safe_load()安全读取、yaml.dump()配合default_flow_style=false等参数规范写入,并注意避免自动类型转换、注入风险及编码问题。

pythonyaml配置文件读写方法_pyyaml实战讲解【指导】

Python 中读写 YAML 配置文件,核心靠 PyYAML 库。它轻量、易用、支持主流 YAML 语法,是配置管理的常用选择。关键在于正确安装、安全加载、规范写入,避免常见坑(比如自动类型转换、注入风险)。

安装与基础读取(load)

先用 pip 安装:

pip install pyyaml

读取 YAML 文件推荐使用 yaml.safe_load(),它只解析安全的 YAML 标签(不执行任意代码),适合配置场景:

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

  • 传入打开的文件对象(推荐用 with 自动关闭)
  • 返回 Python 原生数据结构:字典、列表、字符串、数字、布尔、None
  • 若文件格式错误,会抛出 yaml.YAMLError,建议加 try/except

示例:

代悟
代悟

开发者专属的AI搜索引擎

下载

import yaml
with open("config.yaml", "r", encoding="utf-8") as f:
  data = yaml.safe_load(f)
print(data["database"]["host"])  # 如输出 'localhost'

安全写入(dump)与格式控制

yaml.dump() 将 Python 数据写入 YAML 文件。默认输出可能缩进混乱、带引号或省略空行,可通过参数优化可读性:

  • default_flow_style=False:禁用内联格式,强制块状结构(更易读)
  • allow_unicode=True:保留中文等非 ASCII 字符,不转义
  • indent=2:设置缩进空格数(默认为 2,可显式指定)
  • sort_keys=False:保持字典原有键序(Python 3.7+ 默认有序,但显式设为 False 更稳妥)

示例:

with open("config.yaml", "w", encoding="utf-8") as f:
  yaml.dump(data, f, default_flow_style=False, allow_unicode=True, indent=2, sort_keys=False)

处理常见配置需求

实际项目中常遇到几类典型情况:

  • 环境区分:用不同 YAML 文件(如 dev.yaml / prod.yaml),或在单文件中用锚点(&common)和引用(*common)复用配置
  • 敏感信息保护:不要把密码、密钥直接写进 YAML;可用占位符(如 password: ${DB_PASSWORD}),再结合 os.getenv() 运行时替换
  • 注释保留?:PyYAML 原生不支持读写注释(解析时丢弃)。如需维护注释,可考虑 ruamel.yaml 替代(功能更强,但依赖稍重)

避坑提醒

几个高频问题需注意:

  • 别用 yaml.load()(无 safe 版本)——存在反序列化漏洞,尤其加载不受信内容时
  • YAML 中 yes/no/on/off 会被自动转成布尔值,如需字符串,请加单/双引号:status: "on"
  • 文件编码务必统一(推荐 UTF-8),否则中文可能乱码;open 时显式声明 encoding="utf-8"
  • 嵌套层级过深或含特殊字符(如冒号后紧跟空格)容易解析失败,建议用在线 YAML 校验器(如 yamlchecker.com)预检

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
pip安装使用方法
pip安装使用方法

安装步骤:1、确保Python已经正确安装在您的计算机上;2、下载“get-pip.py”脚本;3、按下Win + R键,然后输入cmd并按下Enter键来打开命令行窗口;4、在命令行窗口中,使用cd命令切换到“get-pip.py”所在的目录;5、执行安装命令;6、验证安装结果即可。大家可以访问本专题下的文章,了解pip安装使用方法的更多内容。

373

2023.10.09

更新pip版本
更新pip版本

更新pip版本方法有使用pip自身更新、使用操作系统自带的包管理工具、使用python包管理工具、手动安装最新版本。想了解更多相关的内容,请阅读专题下面的文章。

432

2024.12.20

pip设置清华源
pip设置清华源

设置方法:1、打开终端或命令提示符窗口;2、运行“touch ~/.pip/pip.conf”命令创建一个名为pip的配置文件;3、打开pip.conf文件,然后添加“[global];index-url = https://pypi.tuna.tsinghua.edu.cn/simple”内容,这将把pip的镜像源设置为清华大学的镜像源;4、保存并关闭文件即可。

797

2024.12.23

python升级pip
python升级pip

本专题整合了python升级pip相关教程,阅读下面的文章了解更多详细内容。

370

2025.07.23

python中print函数的用法
python中print函数的用法

python中print函数的语法是“print(value1, value2, ..., sep=' ', end=' ', file=sys.stdout, flush=False)”。本专题为大家提供print相关的文章、下载、课程内容,供大家免费下载体验。

192

2023.09.27

python print用法与作用
python print用法与作用

本专题整合了python print的用法、作用、函数功能相关内容,阅读专题下面的文章了解更多详细教程。

17

2026.02.03

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

718

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

219

2023.09.04

Rust内存安全机制与所有权模型深度实践
Rust内存安全机制与所有权模型深度实践

本专题围绕 Rust 语言核心特性展开,深入讲解所有权机制、借用规则、生命周期管理以及智能指针等关键概念。通过系统级开发案例,分析内存安全保障原理与零成本抽象优势,并结合并发场景讲解 Send 与 Sync 特性实现机制。帮助开发者真正理解 Rust 的设计哲学,掌握在高性能与安全性并重场景中的工程实践能力。

4

2026.03.05

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 4.8万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.8万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号