ruamel.yaml round_trip_dump()丢失注释问题咨询

我在使用ruamel.yaml时遇到一个问题：YAML().dump()能正确保留注释，但round_trip_dump()会丢失部分注释。调试发现obj.ca.items里注释是存在的，不确定是bug还是用法错误。我需要把dump结果转为字符串存入数据库VARCHAR字段，环境是ruamel.yaml==0.17.21，Python 3.11，64位Windows系统。

可复现代码 #

from ruamel.yaml import round_trip_load, round_trip_dump, YAML
import sys

obj = round_trip_load('''\
a: 1  # comment for a
b:  # comment for b
  c: 2  # comment for c
''')

print('-------------------------- YAML().dump(obj, sys.stdout)')
YAML().dump(obj, sys.stdout)

print('-------------------------- print(round_trip_dump(obj))')
print(round_trip_dump(obj))

输出结果 #

-------------------------- YAML().dump(obj, sys.stdout)
a: 1  # comment for a
b:  # comment for b
  c: 2  # comment for c
-------------------------- print(round_trip_dump(obj))
a: 1
b:  # comment for b
  c: 2

问题解答 #

这不是你的用法错误，而是round_trip_dump()函数在旧版本中的一个问题。你使用的ruamel.yaml==0.17.21里，round_trip_dump()默认没有启用完整的注释保留逻辑，而YAML()实例的dump方法默认是启用该逻辑的。

如果要通过round_trip_dump()得到保留所有注释的字符串，可以手动指定Dumper参数：

import ruamel.yaml
print(round_trip_dump(obj, Dumper=ruamel.yaml.RoundTripDumper))

更推荐的方式是使用YAML()实例生成字符串，这也是官方推荐的现代用法，能避免旧函数的潜在问题：

yaml = YAML()
result_str = yaml.dump_to_string(obj)
print(result_str)

这种方式可以正确保留所有注释，满足你存入数据库VARCHAR字段的需求。

内容的提问来源于stack exchange，提问作者John Lin