[Python-checkins] gh-104112: link from cached_property docs to method-caching FAQ (#104113)

carljm webhook-mailer at python.org
Thu May 4 18:38:59 EDT 2023


https://github.com/python/cpython/commit/fa86a77589a06661fcebb806d36f3a7450e2aecf
commit: fa86a77589a06661fcebb806d36f3a7450e2aecf
branch: main
author: Carl Meyer <carl at oddbird.net>
committer: carljm <carl at oddbird.net>
date: 2023-05-04T16:38:53-06:00
summary:

gh-104112: link from cached_property docs to method-caching FAQ (#104113)

Co-authored-by: Shantanu <12621235+hauntsaninja at users.noreply.github.com>

files:
M Doc/library/functools.rst

diff --git a/Doc/library/functools.rst b/Doc/library/functools.rst
index 29cbc87bf66d..40f43f8b3519 100644
--- a/Doc/library/functools.rst
+++ b/Doc/library/functools.rst
@@ -110,18 +110,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
 



More information about the Python-checkins mailing list