使用默认方法正常加载YAML配置

时间:2015-07-16 03:24:45

标签: python configuration yaml pyyaml

我试图找到一种优雅的方法来将存储在YAML文件中的值加载到我的__init__函数中以用于多个类。如果我有一个包含以下内容的YAML文件:

#YAML
an_object:
  var_a: 1
  var_b: 2

使用以下模块:

class SomeClass(object):
    def __init__(self, var_a=10, var_b=20, var_c=30):
        self.var_a = var_a
        self.var_b = var_b
        self.var_c = var_c

我想使用YAML文件中的值(如果存在),否则使用__init__方法默认值(如果它们不存在)。我还希望它可以扩展到许多变量(> 10),所以我不想尝试/除了每个参数。

我的第一直觉是做一些事情:

import yaml 

class SomeClass(object):
    def __init__(self, var_a=10, var_b=20, var_c=30):
        self.var_a = var_a
        self.var_b = var_b
        self.var_c = var_c

        with open('config.yaml','r') as stream:
            cfg = yaml.load(stream)['an_object']

            for key, value in cfg.iteritems():
                if hasattr(self, key):
                    exec("self.{} = {}".format(key, value))

但我不必使用exec,也不想两次分配变量(它有点令人困惑)。有一个更好的方法吗?它也会覆盖非默认函数值,我也不想这样做。

2 个答案:

答案 0 :(得分:1)

您应该使用setattr()

import yaml 

class SomeClass(object):
    def __init__(self, var_a=10, var_b=20, var_c=30):
        self.var_a = var_a
        self.var_b = var_b
        self.var_c = var_c

        with open('config.yaml','r') as stream:
            cfg = yaml.load(stream)['an_object']

            for key, value in cfg.iteritems():
                if hasattr(self, key):
                    setattr(self, key, value)

请注意,无论YAML确定文件中的值,都会将值设置为该类型。因此,您必须注意这与您在对象中的期望相匹配,或者进行显式转换。

另请注意,这是非常低效的,因为对于此类的每个实例,YAML文件都是打开和读取的。如果你创建了许多对象和不同的类,你应该使一个Loader类的所有这些类的子类成为单例,或者在类变量中从yaml读取值,并读入值一次,然后你可以从那里的值(而不是文件)中的每个实例化对象中进行更新。

要防止在YAML中存在值时分配默认值,您必须首先测试这些值是否存在,然后如果不存在则采用默认值:

import ruamel.yaml as yaml

class Loader(object):
    _val = None

    @property
    def yaml_values(self):
        if Loader._val is None:
            with open('config.yaml','r') as stream:
                Loader._val = yaml.load(stream)
        return Loader._val

    def get_val(self, object_id, key, default):
        try:
            return self.yaml_values[object_id][key]
        except KeyError:
            return default


class SomeClass(Loader):
    obj_id = 'an_object'

    def __init__(self, var_a=10, var_b=20, var_c=30):
        for key in ['var_a', 'var_b', 'var_c']:
            setattr(self, key,
                    self.get_val(SomeClass.obj_id, key, locals()[key]))

    def __repr__(self):
        return 'SomeClass(var_a={}, var_b={}, var_c={})'.format(
            self.var_a, self.var_b, self.var_c)


sc = SomeClass()
print sc

将打印:

SomeClass(var_a=1, var_b=2, var_c=30)

答案 1 :(得分:0)

我没有把YAML放在__init__中,而是意识到在创建对象时最好使用配置:

import yaml 

class SomeClass(object):
    def __init__(self, var_a=10, var_b=20, var_c=30):
        self.var_a = var_a
        self.var_b = var_b
        self.var_c = var_c

if __name__ == 'main':
    with open('config.yaml','r') as stream:
        cfg = yaml.load(stream)
    sc = SomeClass(**cfg)

这保留了默认值,唯一的主要冲突是分配多个关键字,但这是一个简单的解决方法。