From bbc24b2bd569108b957ed24c5a95ffeaf8cde0db Mon Sep 17 00:00:00 2001 From: Raymond Hettinger Date: Sun, 18 Sep 2022 16:36:20 -0500 Subject: GH-96851: Add link to FAQ entry for caching method calls. (GH-96902) --- Doc/faq/programming.rst | 2 ++ Doc/library/functools.rst | 3 +++ 2 files changed, 5 insertions(+) diff --git a/Doc/faq/programming.rst b/Doc/faq/programming.rst index 6514c00..a3fb2fa 100644 --- a/Doc/faq/programming.rst +++ b/Doc/faq/programming.rst @@ -1897,6 +1897,8 @@ The classes can be used like this: 'blog-why-python-rocks' +.. _faq-cache-method-calls: + How do I cache method calls? ---------------------------- diff --git a/Doc/library/functools.rst b/Doc/library/functools.rst index 47cbe59..943a05c 100644 --- a/Doc/library/functools.rst +++ b/Doc/library/functools.rst @@ -197,6 +197,9 @@ The :mod:`functools` module defines the following functions: The cache keeps references to the arguments and return values until they age out of the cache or until the cache is cleared. + If a method is cached, the `self` instance argument is included in the + cache. See :ref:`faq-cache-method-calls` + An `LRU (least recently used) cache `_ works best when the most recent calls are the best predictors of upcoming -- cgit v0.12