Skip to main content

Property caching

Project description

https://travis-ci.org/yola/property-caching.svg?branch=fix/md-to-rst

Cached version of property

Written and used by the folks at Yola to support our free website builder.

Overview

  • cached_property - stores results of decorated methods in decorated object (in _cached_properties attribute)

  • class_cached_property - stores results of decorated methods in the class of decorated object (in _class_cached_properties attribute). All instances will share cached value.

  • clear_property_cache - deletes cached value (works for object cached properties only)

  • set_property_cache - explicitly sets property cache (works for object cached properties only)

  • is_property_cached - allows to check whether property was cached or not (works for object cached properties only)

Usage

from property_caching import (cached_property,
                              class_cached_property,
                              clear_property_cache,
                              set_property_cache,
                              truthy_cached_property)

class Dummy:
    @cached_property
    def foo(self):
        return self.service.expensive_operation()

    @truthy_cached_property
    def bar(self):
        # this value will only be cached if it doesn't evaluate to false:
        return self.service.expensive_operation2()

    @class_cached_property
    def service(self):
        return expensive_service_initialization()

d = Dummy()
d.foo   # calculates result and stores it in d._cached_properties
d.foo   # uses cached value

clear_property_cache(d, 'foo')   # clears cache for property `foo`
set_property_cache(d, 'foo', 42) # explicitly set cache for property `foo`

d2 = Dummy()
d2.foo  # re-calculates value of `foo` but uses cached service

Testing

Install development requirements:

pip install -r requirements.txt

Run the tests with:

python setup.py test
https://travis-ci.org/yola/property-caching.svg?branch=fix/md-to-rst

Project details


Download files

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

Source Distribution

property-caching-1.1.0.tar.gz (3.9 kB view details)

Uploaded Source

File details

Details for the file property-caching-1.1.0.tar.gz.

File metadata

File hashes

Hashes for property-caching-1.1.0.tar.gz
Algorithm Hash digest
SHA256 d2bc1d6dce8e1512f62217e62e84f216163405f45a5a06a5058878126aac9647
MD5 3fdd02c37e002a420e26ec56da4c1a52
BLAKE2b-256 3dea630e58b10fc10a81f22d64ed265db759cb539535069bfb3c4d7222429d60

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page