]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-35300: Add usage note to the lru_cache() docs (GH-10707) (GH-10708)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Mon, 26 Nov 2018 01:00:37 +0000 (17:00 -0800)
committerRaymond Hettinger <rhettinger@users.noreply.github.com>
Mon, 26 Nov 2018 01:00:37 +0000 (17:00 -0800)
Doc/library/functools.rst

index 8924593464f9cf1a5097d6ea7262d20010bd5cb8..d19373bb493d5872ef597bc5ad145ee0f8447a54 100644 (file)
@@ -85,6 +85,11 @@ The :mod:`functools` module defines the following functions:
    The cache's size limit assures that the cache does not grow without bound on
    long-running processes such as web servers.
 
+   In general, the LRU cache should only be used when you want to reuse
+   previously computed values.  Accordingly, it doesn't make sense to cache
+   functions with side-effects, functions that need to create distinct mutable
+   objects on each call, or impure functions such as time() or random().
+
    Example of an LRU cache for static web content::
 
         @lru_cache(maxsize=32)