python 使用 Pyyaml 并保持格式

Question

这是一个配置文件，我使用 PyYAML 从中更改一些值，然后我写了一些配置，但它会改变我的格式，这让我很困惑。

 $ results.yaml 
 nas:
     mount_dir: '/nvr'
     mount_dirs: ['/mount/data0', '/mount/data1', '/mount/data2']

# yaml.py

import yaml.py

conf = open("results.conf", "r")
results = yaml.load(conf)
conf.close()

result['nas']['mount_dirs'][0]= "haha"

with open('/home/zonion/speedio/speedio.conf', 'w') as conf:
    yaml.dump(speedio, conf, default_flow_style=False)

conf.close()

但是它改变了我的格式，我该怎么办？

# cat results.conf
nas:
  mount_dir: /nvr
  mount_dirs:
  - haha
  - /mount/data1
  - /mount/data2

Answer 1

如果您使用 ruamel.yaml ¹，您可以通过组合 this 相对轻松地实现这一目标和 this在 StackOverlow 上回答。

默认 ruamel.yaml 规范化为 2 的缩进，并删除多余的引号。由于您似乎不希望这样，您必须显式设置缩进，或者让 ruamel.yaml 分析输入，并告诉它保留引号:

import sys
import ruamel.yaml
import ruamel.yaml.util

yaml_str = """\
nas:
    mount_dir: '/nvr'
    mount_dirs: ['/mount/data0', '/mount/data1', '/mount/data2']
"""

result, indent, block_seq_indent = ruamel.yaml.util.load_yaml_guess_indent(
    yaml_str, preserve_quotes=True)
result['nas']['mount_dirs'][0] = "haha"
ruamel.yaml.round_trip_dump(result, sys.stdout, indent=indent,
                            block_seq_indent=block_seq_indent)

代替 load_yaml_guess_indent() 调用你可以这样做:

result = ruamel.yaml.round_trip_load(yaml_str, preserve_quotes=True)
indent = 4
block_sequence_indent = None 

如果您希望 haha 在输出中被(单)引号使它成为 SingleQuotedScalarString:

result['nas']['mount_dirs'][0] = \
       ruamel.yaml.scalarstring.SingleQuotedScalarString("haha")

输出将是:

nas:
    mount_dir: '/nvr'
    mount_dirs: ['haha', '/mount/data1', '/mount/data2']

(鉴于您的简短示例输入没有 block 样式序列，block_sequence_indent 无法确定并且将为 None)

---

当使用较新的 API 时，您可以分别控制映射和序列的缩进:

yaml = ruamel.yaml.YAML()
yaml.indent(mapping=4, sequence=6, offset=3)  # not that that looks nice
data = yaml.load(some_stream)
yaml.dump(data, some_stream)

这将使您的 YAML 格式保持一致(如果一开始不是这样的话)，并且在第一次往返之后不会做进一步的更改。

---

¹ _{免责声明:我是该软件包的作者。}