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

示例:

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

UP简历
UP简历

基于AI技术的免费在线简历制作工具

下载

安全写入(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)预检

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

751

2023.06.15

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

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

636

2023.07.20

python能做什么
python能做什么

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

758

2023.07.25

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

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

618

2023.07.31

python教程
python教程

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

1262

2023.08.03

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

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

547

2023.08.04

python eval
python eval

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

577

2023.08.04

scratch和python区别
scratch和python区别

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

706

2023.08.11

Java 桌面应用开发(JavaFX 实战)
Java 桌面应用开发(JavaFX 实战)

本专题系统讲解 Java 在桌面应用开发领域的实战应用,重点围绕 JavaFX 框架,涵盖界面布局、控件使用、事件处理、FXML、样式美化(CSS)、多线程与UI响应优化,以及桌面应用的打包与发布。通过完整示例项目,帮助学习者掌握 使用 Java 构建现代化、跨平台桌面应用程序的核心能力。

34

2026.01.14

热门下载

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

精品课程

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

共4课时 | 0.6万人学习

Django 教程
Django 教程

共28课时 | 3.1万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.1万人学习

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

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