【问题标题】:Configuration file format, complex datastructures (list, dictionaries), comments, editable配置文件格式、复杂数据结构(列表、字典)、注释、可编辑
【发布时间】:2015-06-07 13:09:30
【问题描述】:

我长期以来一直使用普通的 python 文件进行配置。我可以包含 cmets(如果变量名不够,可以提醒我一个条目是什么)并支持列表和字典。

现在我需要为客户导入一些东西,这似乎有点危险,因为如果他们手动编辑错误可能会破坏系统。

将来我希望能够从程序中更新文件,并且还能够使用普通编辑器对其进行编辑(并且不想匹配 <> 或 ():

  • XML 不合适,因为它是 ascii 伪装的二进制
  • .ini 文件的层次结构很少
  • JSON 无法处理 cmets。

我现在正在考虑将 cmets 添加到 JSON,但这基本上需要重写解析器以保留 cmets。而且 JSON 的可读性不是很好。

有一个 ConfigObj 库用于保存 cmets 的 .ini 文件,但 .ini 可以满足我的需要(包含 dicts 列表值的 dicts 列表)。

还有其他我应该使用的配置文件格式吗?或者我应该在导入它们之前以安全的方式解析我的.py 文件(这也允许再次将它们写出来)?

【问题讨论】:

  • 您可能会查看 YAML(我不确定它是否支持您的要求)。或者,您可以在 JSON 中的“cmets”键下简单地包含 cmets。它可能看起来像一个杂物,但它还有一个额外的好处,就是可以轻松地解析和操作您的 cmets。

标签: python config


【解决方案1】:

正如 Chazeon 和 jme 所说,您应该看看 YAML。它支持嵌套数据结构(list(YAML 中的序列)、dict(映射)和各种原语(整数、浮点数、字符串、日期)。

YAML 还支持行尾 cmets(与 # 一起引入),但 Chazeon 提到的“标准”PyYAML 解析器在读取数据时会丢弃这些(并且无法写入)。

从 PyYAML 派生的包 ruamel.yaml(我是作者)在进行往返时保留 cmets(YAML 文件到 python 数据结构到 YAML 文件)。它还保留了大部分 YAML 格式(列表和字典的块与单行)。

然而,缩进是“标准化的”,因此所有块映射和序列在第一次往返后看起来都一样。缩进默认为 2 个空格,但可以单独设置,也可以使用例如,在序列元素之前的空格内“推入”破折号。 yaml.indent(mapping=3, sequence=5, offset=2)

【讨论】:

    【解决方案2】:

    你考虑过 YAML 吗?它可以让 cmets 以 # 开头,并且已经存在一些像 PyYAML 这样的解析器。

    据我所知,MongoDB等一些比较大的程序是使用YAML作为配置文件的,也有一些程序使用YAML将元数据存储在文件前面,例如Pandoc在Markdown前面支持yaml,.

    有关更多信息,您可以访问The Official YAML Website,它提供了一些很好的示例和大量信息或维基百科页面。

    【讨论】:

      【解决方案3】:

      对我来说(只是我的看法)

      我将使用 JSON,因为它体积小、易于阅读并且与几乎所有语言和平台兼容。 为了发表评论,我将使用一些关键字,例如“评论”并将其分配为 JSON 标记。 JSON 无论如何都会忽略未使用的标签。

      JSON 示例

      {
          "param1" : "value1",
          "param2" : "value2",
      }
      

      带有我的评论的 JSON 示例

      {
          "param1" : "value1",
          "param2" : "value2",
          "Comment" : "My Comment."
      }
      

      顺便说一句,根据我的经验,我们不能依赖客户来编辑任何格式化数据 JSON、XML、ini 甚至 YAML。他们会刹车。

      【讨论】:

        猜你喜欢
        • 2017-04-06
        • 1970-01-01
        • 2015-11-08
        • 1970-01-01
        • 2012-09-25
        • 1970-01-01
        • 1970-01-01
        • 2018-08-10
        • 2019-12-14
        相关资源
        最近更新 更多