property-cached 1.6.4

为什么？

• 使缓存耗时或计算成本高的属性变得快速且简单。

• 因为我厌倦了从非Web项目复制粘贴这段代码到非Web项目中。

如何使用它

让我们定义一个具有成本高昂的属性的类。每次你停留在这里，价格都会上涨50美元！

class Monopoly(object):

    def __init__(self):
        self.boardwalk_price = 500

    @property
    def boardwalk(self):
        # In reality, this might represent a database call or time
        # intensive task like calling a third-party API.
        self.boardwalk_price += 50
        return self.boardwalk_price

现在运行它

>>> monopoly = Monopoly()
>>> monopoly.boardwalk
550
>>> monopoly.boardwalk
600

现在让我们将boardwalk属性转换为cached_property。

from cached_property import cached_property

class Monopoly(object):

    def __init__(self):
        self.boardwalk_price = 500

    @cached_property
    def boardwalk(self):
        # Again, this is a silly example. Don't worry about it, this is
        #   just an example for clarity.
        self.boardwalk_price += 50
        return self.boardwalk_price

现在当我们运行它时，价格保持在550美元。

>>> monopoly = Monopoly()
>>> monopoly.boardwalk
550
>>> monopoly.boardwalk
550
>>> monopoly.boardwalk
550

为什么monopoly.boardwalk的值没有改变？因为它是一个缓存属性！

清除缓存

缓存的函数结果可能会被外部力量失效。让我们演示如何强制缓存失效

>>> monopoly = Monopoly()
>>> monopoly.boardwalk
550
>>> monopoly.boardwalk
550
>>> # invalidate the cache
>>> del monopoly.__dict__['boardwalk']
>>> # request the boardwalk property again
>>> monopoly.boardwalk
600
>>> monopoly.boardwalk
600

与线程协同工作

如果很多人同时想留在Boardwalk，怎么办？这意味着使用线程，不幸的是，这会与标准cached_property产生问题。在这种情况下，切换到使用threaded_cached_property

from cached_property import threaded_cached_property

class Monopoly(object):

    def __init__(self):
        self.boardwalk_price = 500

    @threaded_cached_property
    def boardwalk(self):
        """threaded_cached_property is really nice for when no one waits
            for other people to finish their turn and rudely start rolling
            dice and moving their pieces."""

        sleep(1)
        self.boardwalk_price += 50
        return self.boardwalk_price

现在使用它

>>> from threading import Thread
>>> from monopoly import Monopoly
>>> monopoly = Monopoly()
>>> threads = []
>>> for x in range(10):
>>>     thread = Thread(target=lambda: monopoly.boardwalk)
>>>     thread.start()
>>>     threads.append(thread)

>>> for thread in threads:
>>>     thread.join()

>>> self.assertEqual(m.boardwalk, 550)

与async/await协同工作（Python 3.5+）

缓存的属性可以是异步的，在这种情况下，您必须像往常一样使用await来获取值。由于缓存，值只计算一次然后缓存

from cached_property import cached_property

class Monopoly(object):

    def __init__(self):
        self.boardwalk_price = 500

    @cached_property
    async def boardwalk(self):
        self.boardwalk_price += 50
        return self.boardwalk_price

现在使用它

>>> async def print_boardwalk():
...     monopoly = Monopoly()
...     print(await monopoly.boardwalk)
...     print(await monopoly.boardwalk)
...     print(await monopoly.boardwalk)
>>> import asyncio
>>> asyncio.get_event_loop().run_until_complete(print_boardwalk())
550
550
550

请注意，这也与线程不兼容，大多数asyncio对象都不是线程安全的。如果您在每个线程中运行单独的事件循环，缓存的版本很可能会有错误的事件循环。总结一下，要么使用协作式多任务处理（事件循环），要么使用线程，但不要同时使用两者。

缓存超时

有时您希望物品的价格在一段时间后重置。使用cached_property和threaded_cached_property的ttl版本。

import random
from cached_property import cached_property_with_ttl

class Monopoly(object):

    @cached_property_with_ttl(ttl=5) # cache invalidates after 5 seconds
    def dice(self):
        # I dare the reader to implement a game using this method of 'rolling dice'.
        return random.randint(2,12)

现在使用它

>>> monopoly = Monopoly()
>>> monopoly.dice
10
>>> monopoly.dice
10
>>> from time import sleep
>>> sleep(6) # Sleeps long enough to expire the cache
>>> monopoly.dice
3
>>> monopoly.dice
3

注意： ttl工具并不能可靠地清除缓存。这就是为什么它们被拆分成了单独的工具。请参阅https://github.com/pydanny/cached-property/issues/16。

致谢

• @pydanny，他为原始的cached-property实现做出了贡献。

• Pip、Django、Werkzueg、Bottle、Pyramid和Zope，因为它们有自己的实现。这个包最初使用了一个与Bottle版本相匹配的实现。

• Reinout Van Rees，他向我指出了cached_property装饰器。

• @audreyr``_创建了``cookiecutter``_，这使得推出这个包只需@pydanny 15分钟。

• @tinche指出线程问题并提供了解决方案。

• @bcho提供了过期时间功能

历史记录