A cached-property for decorating methods in classes.
Project description
A cached-property for decorating methods in classes.
Why?
Makes caching of time or computational expensive properties quick and easy.
Because I got tired of copy/pasting this code from non-web project to non-web project.
I needed something really simple that worked in Python 2 and 3.
How to use it
Let’s define a class with an expensive property. Every time you stay there the price goes up by $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
Now run it:
>>> monopoly = Monopoly()
>>> monopoly.boardwalk
550
>>> monopoly.boardwalk
600
Let’s convert the boardwalk property into a 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
Now when we run it the price stays at $550.
>>> monopoly = Monopoly()
>>> monopoly.boardwalk
550
>>> monopoly.boardwalk
550
>>> monopoly.boardwalk
550
Why doesn’t the value of monopoly.boardwalk change? Because it’s a cached property!
Credits
Django, Werkzueg, Bottle, and Zope for having their own implementations. This package uses the Django version.
Reinout Van Rees for pointing out the cached_property decorator to me.
My awesome wife Audrey who created cookiecutter, which meant rolling this out took me just 15 minutes.
History
0.1.3 (2014-05-17)
Removed import of package into setup.py
0.1.2 (2014-05-17)
Documentation fixes. Not opening up a RTFD instance for this because it’s so simple to use.
0.1.1 (2014-05-17)
setup.py fix. Whoops!
0.1.0 (2014-05-17)
First release on PyPI.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cached_property-0.1.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c15e882a6b3c3938d2fd275f22be312e411849158ae344f87ed679688eb26601 |
|
MD5 | 4baea2e2a15ba56b5c3726f0c74f62c4 |
|
BLAKE2b-256 | 27c3d5a7ea95544d2c42b52a2f3faceadb34c9510787bed7de7b6be8d6ef222f |