Question

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

{'key1':slowToComputeValue, 'key2':evenSlowerToComputeValue}

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

我从一个简单的开始：

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

由于课堂上有许多getter，我开始认为前三行代码可以由装饰器处理。但是我在做这项工作时遇到了问题。问题是我需要将元数据字典从类实例传递给装饰器。我找到了几个教程和帖子，如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 = {}

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

所以我的问题是：

我怎样才能做到这一点？
装饰者是否是实现我想要做的事情的合适方式？

Answer 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），在这种情况下，保持方法完整但将其标记为已弃用并开始建议用户从现在开始使用新属性是有意义的。

Answer 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)

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

2 个答案: