数据结构格式（YAML 或其他）的往返解析保留注释，用于编写配置

发布于 2024-11-28 06:29:29 字数 405 浏览 2 评论 0原文

我一直在多个应用程序中使用 YAML 作为配置文件格式，一切都很顺利，除了一件事：当我的程序需要在 YAML 配置文件中写入/修改配置变量时，它会通过加载和转储整个文件来破坏格式和注释/结构。

（嗯，实际上 YAML 还有另一个问题。大多数用户，其中许多人不是程序员，都会被 YAML 规则的细节所困扰，比如某些地方空格的重要性。但这并不是一个主要的抱怨。

）我更喜欢的是一个 YAML 加载器/转储器，它可以进行往返解析（保留所有空格和注释），或者具有此类解析器的其他一些人类可读的序列化格式。我什至正在考虑使用 Perl 文档和 PPI，因为 PPI 是一个往返安全解析器。或者也许 PPI 可以处理 YAML 或类似的格式？我宁愿不使用 XML，在此之前我会求助于 INI+(JSON|YAML|... 用于键值)。

有什么建议或指示吗？

原文

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

梦罢 2024-12-05 06:29:29

如果您使用块结构 YAML 并且 Python 是可以接受的，那么您
可以使用 Python 包 1 ruamel.yaml 它是
PyYAML 和支持注释的往返保存：

import sys
import ruamel.yaml

inp = """\
# example
name:
  # details
  family: Smith   # very common
  given: Alice    # one of the siblings
"""

yaml = ruamel.yaml.YAML()

code = yaml.load(inp)
code['name']['given'] = 'Bob'

yaml.dump(code, sys.stdout)

结果：

# example
name:
  # details
  family: Smith   # very common
  given: Bob      # one of the siblings

请注意，行尾注释仍然对齐。

code 包含以下内容，而不是普通的 list 和 dict 对象
附有评论的包装版本²。

1 _{使用 pip install ruamel.yaml 安装。适用于 Python 2.6/2.7/3.3+。
免责声明：我是该包的作者。}
² _{ordereddict 用于映射情况，以保留顺序}

If you are using block structured YAML and Python is acceptable, you
can use the Python package¹ ruamel.yaml which is a derivative of
PyYAML and supports round trip preservation of comments:

import sys
import ruamel.yaml

inp = """\
# example
name:
  # details
  family: Smith   # very common
  given: Alice    # one of the siblings
"""

yaml = ruamel.yaml.YAML()

code = yaml.load(inp)
code['name']['given'] = 'Bob'

yaml.dump(code, sys.stdout)

with result:

# example
name:
  # details
  family: Smith   # very common
  given: Bob      # one of the siblings

Note that the end-of-line comments are still aligned.

Instead of normal list and dict objects the code consists of
wrapped versions² on which the comments attached.

¹ _{Install with pip install ruamel.yaml. Works on Python 2.6/2.7/3.3+.
Disclaimer: I am the author of that package.}
² _{ordereddict is used in case of a mapping, to preserve ordering}

回复收藏 0 原文