在PyYAML中创建自定义标签

问题内容：

我正在尝试使用Python的PyYAML创建一个自定义标记，该标记将允许我使用YAML检索环境变量。

import os
import yaml

class EnvTag(yaml.YAMLObject):
    yaml_tag = u'!Env'

    def __init__(self, env_var):
       self.env_var = env_var

    def __repr__(self):
       return os.environ.get(self.env_var)

settings_file = open('conf/defaults.yaml', 'r')
settings = yaml.load(settings_file)

里面defaults.yaml就是：

example: !ENV foo

我不断得到的错误：

yaml.constructor.ConstructorError: 
could not determine a constructor for the tag '!ENV' in 
"defaults.yaml", line 1, column 10

我计划也有多个自定义标签（假设我可以使用此自定义标签）

问题答案：

您的PyYAML类有一些问题：

yaml_tag是区分大小写的，!Env并且!ENV是不同的标记。
因此，根据文档，yaml.YAMLObject使用元类来定义自身，并具有针对这些情况的默认值to_yaml和from_yaml功能。但是，默认情况下，这些函数要求您对自定义标记（在这种情况下!ENV）的参数是 mapping 。因此，要使用默认功能，您的defaults.yaml文件必须看起来像这样（例如）：

example: !ENV {env_var: "PWD", test: "test"}

然后，您的代码将保持不变，在我的情况下，print(settings)结果为，{'example': /home/Fred}
但您使用的load不是safe_load-在下面的答案中，Anthon指出这很危险，因为解析的YAML可以覆盖/读取磁盘上任何位置的数据。

你仍然可以很容易地使用你的YAML文件格式，example: !ENV foo-你只需要定义一个适当的to_yaml，并from_yaml在课堂上EnvTag，那些能够分析并发出标，如字符串“foo”变量。

所以：

import os
import yaml

class EnvTag(yaml.YAMLObject):
    yaml_tag = u'!ENV'

    def __init__(self, env_var):
        self.env_var = env_var

    def __repr__(self):
        v = os.environ.get(self.env_var) or ''
        return 'EnvTag({}, contains={})'.format(self.env_var, v)

    @classmethod
    def from_yaml(cls, loader, node):
        return EnvTag(node.value)

    @classmethod
    def to_yaml(cls, dumper, data):
        return dumper.represent_scalar(cls.yaml_tag, data.env_var)

# Required for safe_load
yaml.SafeLoader.add_constructor('!ENV', EnvTag.from_yaml)
# Required for safe_dump
yaml.SafeDumper.add_multi_representer(EnvTag, EnvTag.to_yaml)

settings_file = open('defaults.yaml', 'r')

settings = yaml.safe_load(settings_file)
print(settings)

s = yaml.safe_dump(settings)
print(s)

运行该程序时，输出：

{'example': EnvTag(foo, contains=)}
{example: !ENV 'foo'}

此代码的优点是（1）使用原始的pyyaml，因此无需额外安装，并且（2）添加了一个表示符。:)

在PyYAML中创建自定义标签

微信关注