Rooba
/
boltons
mirror of https://github.com/mahmoud/boltons.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add cachedproperty and cachedmethod to the cacheutils sphinxdoc

This commit is contained in:
Mahmoud Hashemi 2016-05-17 02:31:48 -07:00
parent 4f3c4bc852
commit 61cfe14ab9
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/cacheutils.rst
View File

@ -29,20 +29,23 @@ the :class:`LRI`, the LRU has threadsafety built in.
.. autoclass:: boltons.cacheutils.LRU
:members:
Automatic function caching
--------------------------
Continuing in the theme of cache tunability and experimentation,
``cacheutils`` also offers a way to pluggably cache function return
values: the :func:`cached` function decorator.
``cacheutils`` also offers a pluggable way to cache function return
values: the :func:`cached` function decorator and the
:func:`cachedmethod` method decorator.
.. autofunction:: boltons.cacheutils.cached
.. autofunction:: boltons.cacheutils.cachedmethod
Similar functionality can be found in Python 3.4's
:func:`functools.lru_cache` decorator, but the functools approach does
not support the same cache strategy modification or sharing the cache
object across multiple functions.
not support the same cache strategy modification, nor does it support
sharing the cache object across multiple functions.
.. autofunction:: boltons.cacheutils.cachedproperty
Threshold-bounded Counting
--------------------------