ruamel.yaml dump 时避免长字符串被自动换行到下一行

胖婷小哥_6970

胖婷小哥_6970

2026-05-10

414人浏览

原创

ruamel.yaml dump 时避免长字符串被自动换行到下一行

ruamel.yaml 默认按 80 字符宽度折行,导致长镜像名(如带 @sha256 的 OCI 引用)在 name: 后被强制换行;只需将 yaml.width 设置为足够大的值(如 1024),即可保持键值在同一行。

ruamel.yaml 默认按 80 字符宽度折行,导致长镜像名(如带 `@sha256` 的 oci 引用)在 `name:` 后被强制换行;只需将 `yaml.width` 设置为足够大的值(如 `1024`),即可保持键值在同一行。

在使用 ruamel.yaml 处理 OpenShift ImageSetConfiguration 等结构化 YAML 配置时,常遇到一个看似“格式错乱”实则源于默认排版策略的问题:当 additionalImages 列表中某项的 name 值过长(例如含完整 digest 的容器镜像地址)时,dump() 会将其从 name: xxx 拆分为两行:

- name: 
    quay.io/modh/cuda-notebooks@sha256:00c53599f5085beedd0debb062652a1856b19921ccf59bd76134471d24c3fa7d

这并非解析错误,而是 ruamel.yaml 的输出宽度限制(width)触发的自动折行行为。其默认 yaml.width = 80,一旦某行(含缩进)预估长度超过该阈值,就会尝试将长标量值(scalar)换行并缩进显示,以提升可读性——但在配置文件场景下,这种“友好”反而破坏了语义清晰性和工具链兼容性(如 oc apply 或 CI 解析器更倾向单行键值)。

✅ 正确解决方式是显式增大 width:

from ruamel.yaml import YAML

yaml = YAML()
yaml.width = 1024  # 关键:禁用因长度触发的换行
# 可选:保持其他风格一致
yaml.indent(mapping=2, sequence=4, offset=2)
yaml.default_flow_style = False

doc = """..."""  # 你的原始 YAML 字符串
data = yaml.load(doc)
yaml.dump(data, stdout)

⚠️ 注意事项:

  • width 是输出端控制参数,不影响加载(load)行为;
  • 不要混淆 yaml.width 与 yaml.preserve_quotes、yaml.compact() 等——后者不解决此问题;
  • 若需兼顾人类可读性与机器友好性,推荐 width=1024(远超常见镜像名长度),既避免折行,又不会引入异常宽行;
  • 对于超大配置文件(数百个镜像),该设置可显著提升生成 YAML 的整洁度与下游工具稳定性。

通过这一简单配置,即可确保所有 name: 始终保持单行紧凑格式,让 YAML 既是可维护的源码,也是可靠的声明式配置载体。

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

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

下载

相关标签:

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

相关专题

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

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

2023.07.20

1731

4

python能做什么
python能做什么

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

2023.07.25

4444

7

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

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

2023.07.31

1709

3

python教程
python教程

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

2023.08.03

26117

23

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

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

2023.08.04

3167

5

python eval
python eval

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

2023.08.04

3187

5

scratch和python区别
scratch和python区别

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

2023.08.11

1183

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2463

5

热门下载

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

精品课程

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

共6课时 | 54.7万人学习

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

共89课时 | 133.7万人学习