通过配置文件创建函数实例

Question

我们有一个作为字典读取和存储的配置文件，例如

config = {'type': A, 'input': {'color': 'red', 'border': 'thick', 'shape': 'square'}}

现在我们想使用这个配置对象来创建一个类的实例，例如 Drawing_Class ，条件是如果类型是 ' A'，颜色始终为蓝色，如果类型为“B”，则形状始终为圆形。

我写了一个函数来实现这一点，这看起来非常不Python，并且想知道是否有更好的方法来实现我的目标？当然，在我给出的示例中，可以只在配置文件中输入所需的颜色和形状，但实际问题更复杂，这是无法实现的。

这是我的功能。

def drawing_dictionary(type):
    if type == 'A':
        value = config['inputs'].pop('color')
        output = drawing_function(**config['inputs'], colour='blue')
        config['input']['color'] = value

    if type == 'B':
        value = config['inputs'].pop('shape')
        output = drawing_function(**config['inputs'], shape='circle')
        config['input']['shape'] = value

    return output

它实现了我需要它实现的目标，即基于此配置文件创建自定义实例，但以一种看起来非常不优雅的方式。非常感谢您的帮助。

Answer 1

我喜欢使用 dict 来代替可能很大的 if-elif 块，因此我要做的第一件事是创建类型名称的查找，其中包含字段名称和默认值对于每种类型。

types = {
    "A": ("color", "blue"),
    "B": ("shape", "circle"),
}

我还建议复制配置表的内容，而不是修改它。这可以防止您意外修改它，并且还可以使该函数具有可重入性。这是我的版本：

def drawing_dictionary(typename):
    key, default = types[typename]
    kwargs = config["inputs"].copy()
    kwargs[key] = default
    return drawing_function(**kwargs)

通过此实现，支持新类型就像在 types 中添加一行一样简单，而不是定义新的 if 块。

Answer 2

我问了一个关于 Drawing_function 的问题，但我想我应该在答案中写下一些内容并根据需要进行更新。

首先，不要命名变量类型，因为虽然它不是 python 中的保留关键字，但它是一个内置函数，允许您确定对象的类型。

其次，你说你想创建一个函数的实例，你是在谈论函子吗？ Drawing_function 是一个类吗？或者您只是根据配置文件调用具有不同参数的函数（这是您的代码似乎表明的内容以及我的假设）？

项目中的其他代码将影响您要使用的参数列表以及您希望如何移动数据以便函数获取正确的参数。您的示例代码看起来像是您已将 config 设置为全局变量，我不推荐这样做。

如果配置文件中有额外的值或缺少值怎么办？你会导致异常，我添加了一个理论验证例程。

对示例代码的一些建议更改：

def drawing_dictionary(config):
    config = validate_config(config) #remove values you don't understand
    #and confirm all the values you need are present set type to 'Error' 
    #if something is wrong
    if config['type'] == 'Error':
        handle_error()#maybe set a default config?
    else: #this assumes you can't fix the config
        return drawing_function(**config['inputs'],config_type=config['type'])

    return some_sort_of_error_value_or_throw_exception

在 Drawing_function 内部，您将解压 config['inputs'] 中的所有值，这样您将拥有一个名为 color 的变量和一个名为 shape 的变量，然后您可以在该函数中按类型处理更改确保它总是发生并且不更改配置字典：

if config_type == 'A':
    colour = 'blue'
elif config_type == 'B':
    shape = 'circle'

您还可以将 if elif 内容替换为 火柴盒如果您使用的是 python 3.10 或更高版本，请声明。

Answer 3

看来您有一个具有全局配置的配置层次结构“if A then color=blue, if B then shape= Circle”优先于配置文件。这样的层次结构可以借助 collections.ChainMap 进行建模，请参见以下示例：

from collections import ChainMap


GLOBAL_CONFIG = {
    'A': dict(color='blue'),
    'B': dict(shape='circle'),
}


def drawing_dictionary(config):
    return drawing_function(**ChainMap(
        GLOBAL_CONFIG.get(config['type'], {}),
        config['input'],
    ))


def drawing_function(**kwargs):
    import pprint
    pprint.pprint(kwargs)


drawing_dictionary({'type': 'A', 'input': {'color': 'red', 'border': 'thick', 'shape': 'square'}})
drawing_dictionary({'type': 'B', 'input': {'color': 'red', 'border': 'thick', 'shape': 'square'}})