YAML文件序列化与反序列化时的字段顺序及数组格式异常问题解决咨询

这两个问题都是PyYAML默认的序列化行为导致的，咱们来逐个解决：

1. 修复字段顺序错乱的问题 #

PyYAML在dump时默认会对字典的键进行排序（sort_keys=True），这就是为什么type和class_names的顺序颠倒了。只需要在yaml.dump时添加sort_keys=False参数，就能保持加载时的字段顺序（注意：Python 3.7+ 原生字典是插入有序的，PyYAML 5.1+ 加载后会保留原文件的字段顺序）。

2. 修复数组从内联变块级的问题 #

PyYAML默认会把列表序列化为块级格式（用-开头），如果想保持原有的内联格式（["item1", "item2"]），可以通过default_flow_style参数控制：

• 如果希望所有列表都保持内联格式，同时字典保持块级，可以设置default_flow_style=None（PyYAML会自动判断，短列表会用内联）；
• 如果希望强制所有列表使用内联格式，可以设置default_flow_style=True（但这会让整个字典也变成内联格式，可能不是你想要的）；
• 要是想完全匹配原文件的混合格式（字典块级，列表内联），需要自定义Dumper类来处理列表的序列化。

修改后的代码示例 #

下面是同时解决两个问题的代码，这里用sort_keys=False保持字段顺序，用default_flow_style=None让PyYAML自动选择合适的列表格式（接近原文件的内联风格）：

import yaml
import sys
def main(argv):
    with open('file_base.yaml') as f:
        data = yaml.load(f, Loader=yaml.FullLoader)
    
    # 保存时指定参数修复两个问题
    with open('the_new.yaml', 'w') as f:
        # sort_keys=False 保持字段顺序，default_flow_style=None 自动选择列表格式
        yaml.dump(data, f, sort_keys=False, default_flow_style=None)
    
    # 验证输出
    with open('the_new.yaml', 'r') as f:
        print(f.read())

if __name__ == '__main__':
    main(sys.argv[1:])

如果运行上面的代码，生成的the_new.yaml会和原文件几乎一致：

first_data: # Required.
  type: ad
  class_names: ["hello", "dog", "cat", "lion", "human"]

自定义Dumper实现精确格式匹配（可选） #

如果你需要严格保证列表始终以内联格式输出，不管长度，可以自定义Dumper：

class InlineListDumper(yaml.Dumper):
    def represent_sequence(self, tag, sequence, flow_style=None):
        # 强制列表使用内联格式
        return super().represent_sequence(tag, sequence, flow_style=True)

# 使用自定义Dumper
with open('the_new.yaml', 'w') as f:
    yaml.dump(data, f, Dumper=InlineListDumper, sort_keys=False)

这样生成的文件中所有列表都会是内联格式，同时字段顺序保持不变。

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