bpo-40571: Make lru_cache(maxsize=None) more discoverable by rhettinger · Pull Request #20019 · python/cpython · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions Doc/library/functools.rst
11 changes: 10 additions & 1 deletion Lib/functools.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
# See C source code for _functools credits/copyright

__all__ = ['update_wrapper', 'wraps', 'WRAPPER_ASSIGNMENTS', 'WRAPPER_UPDATES',
'total_ordering', 'cmp_to_key', 'lru_cache', 'reduce',
'total_ordering', 'cache', 'cmp_to_key', 'lru_cache', 'reduce',
'TopologicalSorter', 'CycleError',
'partial', 'partialmethod', 'singledispatch', 'singledispatchmethod',
'cached_property']
Expand Down Expand Up @@ -888,6 +888,15 @@ def cache_clear():
pass


################################################################################
### cache -- simplified access to the infinity cache
################################################################################

def cache(user_function, /):
Comment thread
rhettinger marked this conversation as resolved.
'Simple lightweight unbounded cache. Sometimes called "memoize".'
return lru_cache(maxsize=None)(user_function)


################################################################################
### singledispatch() - single-dispatch generic function decorator
################################################################################
Expand Down
19 changes: 19 additions & 0 deletions Lib/test/test_functools.py
Original file line number Diff line number Diff line change
Expand Up @@ -1432,6 +1432,25 @@ def check_order_with_hash_seed(seed):
self.assertEqual(run1, run2)


class TestCache:
# This tests that the pass-through is working as designed.
# The underlying functionality is tested in TestLRU.

def test_cache(self):
@self.module.cache
def fib(n):
if n < 2:
return n
return fib(n-1) + fib(n-2)
self.assertEqual([fib(n) for n in range(16)],
[0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144, 233, 377, 610])
self.assertEqual(fib.cache_info(),
self.module._CacheInfo(hits=28, misses=16, maxsize=None, currsize=16))
fib.cache_clear()
self.assertEqual(fib.cache_info(),
self.module._CacheInfo(hits=0, misses=0, maxsize=None, currsize=0))


class TestLRU:

def test_lru(self):
Expand Down