将 YAML 配置值输入到 Python 的关键字参数中

Question

我想要一个 YAML 配置文件，用于我的 Python 脚本的某些分析设置。 YAML 文件看起来像这样：

settings:
  param1: 1
  param2: two
  ...

在我的 Python 脚本中，我想将这些值作为关键字参数传递给函数。加载 YAML 文件会为我提供一本字典。该函数只有关键字参数，我事先不知道配置文件将具有哪些关键字参数。该函数看起来像这样：

def process(param1=None, param2=None, param3=None):
    ...

请注意，YAML 设置的名称与关键字参数名称相同。该函数有几个可能的关键字参数，而配置文件可能只有一两个。显然，我想将值分配给正确的关键字参数。

如何将 YAML 值（和/或字典）分配给其关键字参数分配？

Answer 1

您可以从

yaml.load()

获取字典并使用

**

语法将键/值传递到函数中。这样您就不必事先知道密钥。例如：

import yaml

with open('path/to/config.yml', 'rb') as f:
    conf = yaml.safe_load(f.read())    # load the config file

def process(**params):    # pass in variable numbers of args
    for key, value in params.items():
        print('%s: %s' % (key, value))

process(**conf)    # pass in your keyword args

用您的代码尝试一下，它应该能让您充分了解如何实现自己的代码。

Answer 2

所以，我遇到了你的问题，我认为这可能会有所帮助。 PyYAML 太棒了！它支持的功能之一是直接从 python 进行类映射

import yaml
class Hero:
    def __init__(self, name, hp, sp):
        self.name = name
        self.hp = hp
        self.sp = sp
    def __repr__(self):
        return "Hero %s has %d Hitpoints" % (self.name, self.hp)


f = "sample.yml"
with open(f, mode='w') as ff:
    ff.write(yaml.dump(Hero(name="Cool Guy", hp=4, sp=10)))

    # saves as !!python/object:__main__.Hero {hp: 4, name: Cool Guy, sp: 10}

    ff.close()
with open(f, mode="r") as fx:
    y = yaml.load(fx)
    print(y)

[out]: Hero Cool Guy has 4 Hitpoints

希望你能像我一样从中找到很多用处。查看 PyYAML 文档 了解更多信息。

Answer 3

您可以在 python 中迭代字典中的键，如下所示：

for key in data:
    print(key)

这将允许您获取密钥并通过调用在您的函数中使用它：

data[key] # returns value from dict

Answer 4

bibiflags 正是您所需要的。

参见：https://pypi.org/project/bibiflags/

解析 YAML 中的所有参数

from pathlib import Path
from pprint import pformat

from loguru import logger

from bibiflags.bibiflags import BibiFlags

if __name__ == '__main__':
    flags = BibiFlags(root=str(Path(__file__).parent))
    logger.info(pformat(flags.parameters))

合并 YAML 中的参数和现有的 argparse.ArgumentParser

from pathlib import Path
from pprint import pformat, pprint

from loguru import logger
from bibiflags.bibiflags import BibiFlags

if __name__ == '__main__':
    import argparse

    parser = argparse.ArgumentParser()
    parser.add_argument("echo")
    flags = BibiFlags(argparser=parser,
                      root=str(Path(__file__).parent),
                      app_name='main')

    pprint(flags.parameters)