Python 装饰器在类中获取或设置字典值

Posted 2023-02-23

【中文标题】Python 装饰器在类中获取或设置字典值

【英文标题】：Python decorator get or set dictionary value in class

【发布时间】：2017-12-08 07:36:21

【问题描述】：

我正在研究一个代表具有大量关联数据的对象的类。我将这些数据存储在一个名为metadata 的字典类属性中。表示可以是：

'key1':slowToComputeValue, 'key2':evenSlowerToComputeValue

值的计算在某些情况下非常很慢，所以我想做的是，使用“getter”函数，首先尝试从 元数据中获取值 em>字典。只有在 KeyError 上（即当 getter 尝试获取一个尚不存在的键的值时）才应该计算该值（并添加到字典中以便在下次调用 getter 时快速访问）。

我从一个简单的开始：

try:
    return self.metadata[requested_key]
except KeyError:
    #Implementation of function

由于类中有很多 getter，我开始认为前 3 行代码可以由装饰器处理。但是，我在完成这项工作时遇到了问题。问题是我需要将元数据字典从类实例传递给装饰器。我发现了几个教程和帖子，如this 一个，它们表明可以将参数发送到封闭函数，但我遇到的困难是将类实例化属性元数据发送给它（如果我发送一个字符串值它有效）。

我尝试的一些示例代码在这里：

def get_existing_value_from_metadata_if_exists(metadata):
    def decorator(function):
        @wraps(function)
        def decorated(*args, **kwargs):
            function_name = function.__name__
            if function_name in metadata.keys():
                return metadata[function_name]
            else:
                function(*args, **kwargs)
        return decorated
    return decorator

class my_class():
    @get_existing_value_from_metadata_if_exists(metadata)
    def get_key1(self):
        #Costly value calculation and add to metadata

    @get_existing_value_from_metadata_if_exists(metadata)
    def get_key2(self):
        #Costly value calculation and add to metadata

    def __init__(self):
        self.metadata = 

我得到的错误通常是自我定义的，但我尝试了参数放置、装饰器放置等的各种组合，但没有成功。

所以我的问题是：

我怎样才能完成这项工作？ 装饰器是实现我想要做的事情的合适方式吗？

【问题讨论】：

您是否希望数据即使在 my_class 的不同实例之间也能保持不变？

否 - 每个实例都与一个音频文件相关。所以每个实例都有自己的一组属性。

【参考方案1】：

是的，装饰器是一个很好的用例。例如，Django 已经包含了类似的东西，它叫做cached_property。

基本上，它所做的只是当第一次访问该属性时，它将以与函数相同的名称将数据存储在实例的 dict(__dict__) 中。当我们稍后获取相同的属性时，它会简单地从实例字典中获取值。

cached_property 是 non-data descriptor。因此，一旦在实例的字典中设置了键，对属性的访问将始终从那里获取值。

class cached_property(object):
    """
    Decorator that converts a method with a single self argument into a
    property cached on the instance.

    Optional ``name`` argument allows you to make cached properties of other
    methods. (e.g.  url = cached_property(get_absolute_url, name='url') )
    """
    def __init__(self, func, name=None):
        self.func = func
        self.__doc__ = getattr(func, '__doc__')
        self.name = name or func.__name__

    def __get__(self, instance, cls=None):
        if instance is None:
            return self
        res = instance.__dict__[self.name] = self.func(instance)
        return res

在你的情况下：

class MyClass:
    @cached_property
    def key1(self):
        #Costly value calculation and add to metadata

    @cached_property
    def key2(self):
        #Costly value calculation and add to metadata

    def __init__(self):
        # self.metadata not required

---

使用name 参数将现有方法转换为缓存属性。

class MyClass:
    def __init__(self, data):
        self.data = data

    def get_total(self):
        print('Processing...')
        return sum(self.data)

    total = cached_property(get_total, 'total')

演示：

>>> m = MyClass(list(range(10**5)))

>>> m.get_total()
Processing...
4999950000

>>> m.total
Processing...
4999950000

>>> m.total
4999950000

>>> m.data.append(1000)

>>> m.total  # This is now invalid
4999950000

>>> m.get_total()  # This still works
Processing...
4999951000

>>> m.total
4999950000

根据上面的例子我们可以看到，只要我们知道内部数据还没有更新，我们就可以使用total，从而节省处理时间。但它不会使get_total() 变得多余，因为它可以根据数据得到正确的总数。

另一个例子可能是，我们面向公众的客户目前正在使用某些东西（比如get_full_name()）作为方法，但我们意识到在这种情况下使用它作为属性（只是full_name）更合适保持方法不变但将其标记为已弃用并开始建议用户从现在开始使用新属性是有意义的。

【讨论】：

哇，这是什么魔法......它有效，但我仍在努力解决它。您能否添加一个使用名称 kwarg 的示例？

@user3535074 “name kwarg”是什么意思？

'name=None' 部分 -> def __init__(self, func, name=None)

【参考方案2】：

解决这个问题的另一种方法是像这样使用类“属性”：

class MyClass():
    def __init__():
        self._slowToComputeValue = None
    @property
    def slowToComputeValue(self):
        if self._slowToComputeValue is None:
            self._slowToComputeValue = self.ComputeValue()
        return self._slowToComputeValue
    def ComputeValue(self):
        pass

现在您可以像访问类属性一样访问它：

myclass = MyClass()
print(myclass.slowToComputeValue)