cachetools memoizing attributes (cache, key, lock) are not available
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5.1k
- Forks
- 2.1k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 82
Description
According to cachetools’ documentation,
The decorator’s cache, key and lock parameters are also available as
cache,cache_keyandcache_lockattributes of the memoizing wrapper function. […] For the common use case of clearing or invalidating the cache, the decorator also provides acache_clear()[.]
However, this is currently not reflected in the typeshed stubs. cached() and cachedmethod() are declared to return IdentityFunction, i.e. a decorator that takes the function-to-be-cached and returns a callable with identical signature, without the additional properties and functions. It would be great if support for this was added.
Code example
import cachetools
import threading
## cached function
@cachetools.cached(cache=cachetools.LRUCache(maxsize=10),
key=lambda x, y: y,
lock=threading.Lock())
def fun(x: str, y: str) -> str:
return y
print(fun('ignored', 'hello world'))
with fun.cache_lock:
print(fun.cache[fun.cache_key('ignored', 'hello world')])
fun.cache_clear()
## cached method
class Class:
def __init__(self):
self.cache = cachetools.LRUCache(maxsize=10)
self.lock = threading.Lock()
@cachetools.cachedmethod(cache=lambda self: self.cache,
key=lambda self, x, y: y,
lock=lambda self: self.lock)
def meth(self, x: str, y: str) -> str:
return y
c = Class()
print(c.meth('ignored', 'hello world'))
with c.meth.cache_lock(c):
print(c.meth.cache(c)[c.meth.cache_key(c, 'ignored', 'hello world')])
I’m not sure if this is the “intended” way to use the memoizing attributes of a cached method (passing in c for the self argument explicitly), but it seems to work at runtime, at least. (Personally, I’d be fine with support just for @cached functions, but I figured it makes sense to include @cachedmethod in the example too.)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the typeshed stubs for cachetools.cached() and cachedmethod(), then compare their current return types with cachetools’ documented memoizing attributes. Add typing support for cache, cache_key, cache_lock, and cache_clear where appropriate, and verify the supplied cached-function and cached-method examples with the relevant type-checking tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- developer-experience
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100