Skip to main content

A cached-property for decorating methods in classes.

Project description

https://badge.fury.io/py/cached-property.png https://travis-ci.org/pydanny/cached-property.png?branch=master https://pypip.in/d/cached-property/badge.png

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for cached-property, version 0.1.3
Filename, size File type Python version Upload date Hashes
Filename, size cached_property-0.1.3-py2.py3-none-any.whl (4.2 kB) File type Wheel Python version 3.3 Upload date Hashes View
Filename, size cached-property-0.1.3.tar.gz (5.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page