Merge pull request #19 from jaraco/feature/annotate-method-cache

Add type annotations for method_cache.

CHANGES.rst

@@ -1,3 +1,8 @@
+v3.5.0
+======
+
+Add type annotations to ``method_cache``.
+
 v3.4.0
 ======
 

jaraco/functools.py

@@ -7,6 +7,11 @@
 
 import more_itertools
 
+from typing import Callable, TypeVar
+
+
+CallableT = TypeVar("CallableT", bound=Callable[..., object])
+
 
 def compose(*funcs):
     """
@@ -92,7 +97,12 @@ def wrapper(*args, **kwargs):
     return wrapper
 
 
-def method_cache(method, cache_wrapper=functools.lru_cache()):
+def method_cache(
+    method: CallableT,
+    cache_wrapper: Callable[
+        [CallableT], CallableT
+    ] = functools.lru_cache(),  # type: ignore[assignment]
+) -> CallableT:
     """
     Wrap lru_cache to support storing the cache data in the object instances.
 
@@ -160,17 +170,21 @@ def method_cache(method, cache_wrapper=functools.lru_cache()):
     for another implementation and additional justification.
     """
 
-    def wrapper(self, *args, **kwargs):
+    def wrapper(self: object, *args: object, **kwargs: object) -> object:
         # it's the first call, replace the method with a cached, bound method
-        bound_method = types.MethodType(method, self)
+        bound_method: CallableT = types.MethodType(  # type: ignore[assignment]
+            method, self
+        )
         cached_method = cache_wrapper(bound_method)
         setattr(self, method.__name__, cached_method)
         return cached_method(*args, **kwargs)
 
     # Support cache clear even before cache has been created.
-    wrapper.cache_clear = lambda: None
+    wrapper.cache_clear = lambda: None  # type: ignore[attr-defined]
 
-    return _special_method_cache(method, cache_wrapper) or wrapper
+    return (  # type: ignore[return-value]
+        _special_method_cache(method, cache_wrapper) or wrapper
+    )
 
 
 def _special_method_cache(method, cache_wrapper):

pyproject.toml

@@ -10,8 +10,9 @@ skip-string-normalization = true
 [pytest.enabler.black]
 addopts = "--black"
 
-[pytest.enabler.mypy]
-addopts = "--mypy"
+# disabled for pytest-dev/pytest#8332 (see #19)
+# [pytest.enabler.mypy]
+# addopts = "--mypy"
 
 [pytest.enabler.flake8]
 addopts = "--flake8"