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 ¹，您可以通过在 StackOverlow 上结合 this 和 this 答案来相对轻松地实现此目的。

默认情况下，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_sequence_indent 无法确定并且将为无）

---

使用较新的 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 格式一致（如果一开始不是这样），并且在第一次往返之后不再进行任何更改。

---

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

Answer 2

ruamel.yaml不幸的是不完全保留原始格式，引用其docs：

虽然没有保留行的单个缩进，但您可以 为映射和序列指定单独的缩进级别 （序列计数不包括序列的破折号 元素）和其中的块序列破折号的特定偏移量 缩进。

我不知道有任何 Python 库可以做到这一点。

当我需要更改 YAML 文件而不触及其格式时，我不情愿地使用正则表达式（不情愿地因为它几乎和 parsing XHTML with it 一样糟糕）。

如果您知道，请随时提出更好的解决方案，我很乐意了解它！

Answer 3

ruamel实现了一个往返的loader和dumper，试试：

import ruamel.yaml
conf = open("results.conf", "r")
results = ruamel.yaml.load(conf, ruamel.yaml.RoundTripLoader)
conf.close()
results['nas']['mount_dirs'][0] = "haha"
with open('/home/zonion/speedio/speedio.conf', 'w') as conf:
  ruamel.yaml.dump(results, conf, ruamel.yaml.RoundTripDumper)