Improve type hints.

tkem · tkem · commit 0cdf70c39c63 · 2026-07-07T21:46:28.000+02:00
diff --git a/src/cachetools/__init__.pyi b/src/cachetools/__init__.pyi
@@ -25,6 +25,7 @@ __all__: Final = (
     "TTLCache",
     "cached",
     "cachedmethod",
+    "cachedproperty",
 )
 __version__: str
 
@@ -243,3 +244,17 @@ def cachedmethod(
 ) -> Callable[
     [Callable[Concatenate[Any, _P], _R]], _cachedmethod_wrapper_info[_P, _R]
 ]: ...
+
+@type_check_only
+class _cachedproperty_wrapper(Generic[_R]):
+    __wrapped__: Callable[[Any], _R]
+    __name__: str
+    __doc__: str | None
+    def __set_name__(self, owner: type, name: str) -> None: ...
+    def __get__(self, obj: Any, objtype: type | None = None) -> _R: ...
+
+def cachedproperty(
+    ttl: Any | None = ...,
+    timer: Callable[[], Any] = ...,
+    lock: AbstractContextManager[Any] | None = ...,
+) -> Callable[[Callable[[Any], _R]], _cachedproperty_wrapper[_R]]: ...
diff --git a/src/cachetools/_cachedproperty.py b/src/cachetools/_cachedproperty.py
@@ -21,7 +21,7 @@ def __set_name__(self, owner, name):
             )
 
     def __get__(self, obj, objtype=None):
-        wrapper = self.Wrapper(obj)  # FIXME: wrapper may also be a value?!?
+        wrapper = self.Wrapper(obj)  # type: ignore
         if obj is None:
             # e.g. mocking with autospec=True in unittest.mock
             pass
@@ -54,6 +54,8 @@ def __get__(self, obj, objtype=None):
         return wrapper
 
 
+# TODO: Consider renaming this to _DummyLock (cf. "dummy_threading"), move to some import .py,
+# and also use this in other decorators (after doing some timing), to reduce multiple variants
 class _DefaultLock:
     def __enter__(_self):
         pass
@@ -65,17 +67,35 @@ def __exit__(_self, _exc_type, _exc_value, _traceback):
 _default_lock = _DefaultLock()
 
 
-def _ttl_property(ttl, timer, lock):
-    pass
+def _ttl_property(method, ttl, timer, lock):
+    class Descriptor(_DescriptorBase):
+        class Wrapper:
+            def __init__(self, obj):
+                pass
 
+            def __call__(self, *args, **kwargs):
+                pass
 
-def _property(lock):
-    pass
+    return Descriptor()
+
+
+def _property(method, lock):
+    class Descriptor(_DescriptorBase):
+        class Wrapper:
+            def __init__(self, obj):
+                pass
+
+            def __call__(self, *args, **kwargs):
+                pass
+
+    return Descriptor()
 
 
 def _wrapper(method, ttl, timer, lock=_default_lock):
     if ttl is not None:
         wrapper = _ttl_property(method, ttl, timer, lock)
     else:
         wrapper = _property(method, lock)
-    return functools.update_wrapper(wrapper, method)
+    # functools.update_wrapper() will not accept descriptor (decorator) as wrapper
+    # https://github.com/python/typeshed/issues/9846
+    return functools.update_wrapper(wrapper, method)  # type: ignore
