]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.11] gh-104112: link from cached_property docs to method-caching FAQ (GH-104113...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Thu, 4 May 2023 23:10:34 +0000 (16:10 -0700)
committerGitHub <noreply@github.com>
Thu, 4 May 2023 23:10:34 +0000 (17:10 -0600)
gh-104112: link from cached_property docs to method-caching FAQ (GH-104113)
(cherry picked from commit fa86a77589a06661fcebb806d36f3a7450e2aecf)

Co-authored-by: Carl Meyer <carl@oddbird.net>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Doc/library/functools.rst

index 7438d4cdadc550c142652740b7df7a339c2aaab8..62fcddec090419d80e30734db1d1e8cd3144a9c7 100644 (file)
@@ -102,18 +102,10 @@ The :mod:`functools` module defines the following functions:
    ``__slots__`` without including ``__dict__`` as one of the defined slots
    (as such classes don't provide a ``__dict__`` attribute at all).
 
-   If a mutable mapping is not available or if space-efficient key sharing
-   is desired, an effect similar to :func:`cached_property` can be achieved
-   by a stacking :func:`property` on top of :func:`cache`::
-
-       class DataSet:
-           def __init__(self, sequence_of_numbers):
-               self._data = sequence_of_numbers
-
-           @property
-           @cache
-           def stdev(self):
-               return statistics.stdev(self._data)
+   If a mutable mapping is not available or if space-efficient key sharing is
+   desired, an effect similar to :func:`cached_property` can also be achieved by
+   stacking :func:`property` on top of :func:`lru_cache`. See
+   :ref:`faq-cache-method-calls` for more details on how this differs from :func:`cached_property`.
 
    .. versionadded:: 3.8