如何在 PyYAML 中保留 YAML 字符串中的换行符与缩进空格

轻静姑娘_7022

轻静姑娘_7022

2026-05-13

989人浏览

原创

如何在 PyYAML 中保留 YAML 字符串中的换行符与缩进空格

使用 yaml.safe_load() 解析含换行和缩进的字符串时,默认会折叠多余空白(包括行首空格),导致格式丢失;通过 YAML 的字面量块标量(| 或 |-)可完整保留原始换行与空格。

使用 `yaml.safe_load()` 解析含换行和缩进的字符串时,默认会折叠多余空白(包括行首空格),导致格式丢失;通过 yaml 的字面量块标量(`|` 或 `|-`)可完整保留原始换行与空格。

在 PyYAML 中,safe_load() 对普通双引号或无引号的字符串采用“折叠样式”(folded style)解析规则:它会将连续空白(尤其是行首缩进)规范化,甚至移除空行及前导空格。例如:

import yaml

data = yaml.safe_load("first\n\n         second")
print(repr(data))  # 输出: 'first\nsecond' —— 空行被压缩,缩进空格完全丢失

这并非 bug,而是 YAML 规范对隐式字符串的默认行为(参见 YAML 1.2.2 规范 §8.1.2)。要精确保留换行、空行和行首空格,必须显式使用字面量块标量(literal block scalar),即以 |(保留末尾换行)或 |-(剥离末尾空白行)开头的多行结构。

✅ 正确做法:将原始字符串转换为符合 YAML 字面量语法的格式:

AI-Text-Classifier
AI-Text-Classifier

AI-Text-Classifier是 OpenAI 曾推出的一款用于判断文本是否由 AI 生成的实验性检测工具。

下载
import yaml

# 使用 |- 表示字面量块(strip trailing empty lines)
data = yaml.safe_load("|-\n first\n         second")
print(repr(data))  # 输出: 'first\n         second'

# 若需保留末尾换行,用 |(不带 -)
data_with_trailing = yaml.safe_load("|\n first\n         second\n")
print(repr(data_with_trailing))  # 输出: 'first\n         second\n'

⚠️ 注意事项:

  • 字面量块要求每行内容必须严格缩进(至少比 | 所在行多一个空格),且缩进必须一致(推荐使用空格,避免混用 Tab);
  • | 和 |- 后需紧跟换行符,其后第一行的内容缩进将作为基准,后续各行的相对缩进会被保留;
  • 不要对字面量块内文本额外加引号或转义——YAML 会原样读取;
  • 若输入是动态生成的字符串,建议封装工具函数自动转换为字面量格式,例如:
def literal_yaml(s: str) -> str:
    """将任意字符串转为安全的 YAML 字面量块表示"""
    if not s:
        return "| ''"
    lines = s.splitlines(keepends=True)
    # 确保首行有缩进(避免解析错误)
    indented = ''.join(' ' + line for line in lines)
    return f"|-\n{indented}"

# 示例
raw = "first\n\n         second"
yaml_str = literal_yaml(raw)
result = yaml.safe_load(yaml_str)
assert result == raw  # ✅ 断言通过

总结:PyYAML 的 safe_load 并非“删除空格”,而是遵循 YAML 规范对不同标量风格的语义处理。当需要保真还原原始文本格式(如配置模板、代码片段、日志段落等),务必主动使用 | / |- 字面量语法——这是 YAML 原生支持的、最可靠的方式。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

yy

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.07.20

1651

4

python能做什么
python能做什么

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

2023.07.25

4064

7

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

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

2023.07.31

1649

3

python教程
python教程

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

2023.08.03

23497

23

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

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

2023.08.04

2887

5

python eval
python eval

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

2023.08.04

2907

5

scratch和python区别
scratch和python区别

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

2023.08.11

1143

5

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

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

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2263

5

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习