From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> Date: Sun, 18 Sep 2022 22:53:31 +0000 (-0700) Subject: GH-96851: Add link to FAQ entry for caching method calls. (GH-96902) X-Git-Tag: v3.11.0~45 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=1c345fa01264dae0270b0b93e9b36d7519ab9e59;p=thirdparty%2FPython%2Fcpython.git GH-96851: Add link to FAQ entry for caching method calls. (GH-96902) (cherry picked from commit bbc24b2bd569108b957ed24c5a95ffeaf8cde0db) Co-authored-by: Raymond Hettinger --- diff --git a/Doc/faq/programming.rst b/Doc/faq/programming.rst index 676dfae61aca..76bd1538b410 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 00aca09bc7af..d6792ed6fb77 100644 --- a/Doc/library/functools.rst +++ b/Doc/library/functools.rst @@ -191,6 +191,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