Title: Change `cache`/`lru_cache` typing to retain function signatures by alwaysmpe · Pull Request #12952 · python/typeshed · GitHub
Open Graph Title: Change `cache`/`lru_cache` typing to retain function signatures by alwaysmpe · Pull Request #12952 · python/typeshed
X Title: Change `cache`/`lru_cache` typing to retain function signatures by alwaysmpe · Pull Request #12952 · python/typeshed
Description: My (second - #12945 my comments there aren't really relevant) attempt at fixing the cache & lru_cache typing problem. This is based on a local wrapper I wrote using newer generics syntax, see my comment for the newer generics approach. I'm not sure on type variance and have a few ignores. Mypy and pyright disagree in places too. I defer to maintainers as to what is right, my understanding of type variance is limited. Note: the current implementation is quite clunky. I have attempted to meet the following constraints: Retain the Hashable argument requirement (requires a Hashable descriptor class) Ensure the return type has a cache_info, cache_clear and cache_parameters function Compatible with runtime type behaviour - at runtime the return type is _lru_cache_wrapper and so this must be part of the cached return type. Minimal ignores - _lru_cache_wrapper at runtime isn't subclassable so one of the tests expect it to be annotated with final. Making the descriptor protocols subclasses of this would simplify typing slightly but require ignores. Correct function argument type annotations of the returned callable object It might be possible to simplify the code as is or some of these constraints may be considered not necessary. My takeaway from other conversations is that 2 is a hard requirement of maintainers, 5 is what I want. The other requirements may be negotiable. But using this typeshed fork locally the below code example correctly type checks in pyright without any errors (and all type ignore errors are correctly ignoring an error). # pyright: reportUnnecessaryTypeIgnoreComment=true from functools import cache from typing import ( assert_type, TYPE_CHECKING, overload, override, ) class CFnCls: @cache def fn(self, arg: int) -> int: print("method fn called") return arg @classmethod @cache def cls_fn(cls, arg: int) -> int: print("class fn called") return arg @staticmethod @cache def st_fn(arg: int) -> int: print("static fn called") return arg cfn_inst = CFnCls() cfn_inst.fn(1) cfn_inst.fn.__wrapped__(cfn_inst, 1) CFnCls.fn.__wrapped__(CFnCls(), 1) CFnCls.st_fn(1) CFnCls.st_fn.__wrapped__(1) CFnCls.cls_fn(1) CFnCls.cls_fn.__wrapped__(CFnCls, 1) cfn_inst.fn(1) CFnCls.st_fn(1) CFnCls.cls_fn(1) assert_type(cfn_inst.fn(1), int) assert_type(CFnCls.st_fn(1), int) assert_type(CFnCls.cls_fn(1), int) CFnCls().fn.cache_clear() CFnCls.fn.cache_clear() CFnCls.st_fn.cache_clear() CFnCls.cls_fn.cache_clear() if TYPE_CHECKING: # type errors - correct CFnCls().fn(1, 1) # type: ignore reportCallIssue CFnCls().fn.__wrapped__(CFnCls(), 1, 1) # type: ignore reportCallIssue CFnCls.fn(arg=1) # type: ignore reportCallIssue CFnCls.st_fn(1, 1) # type: ignore reportCallIssue CFnCls.cls_fn(1, 1) # type: ignore reportCallIssue @cache def fn(arg: int) -> int: return arg @cache def df_fn(arg: int, darg: str = "default"): print("default fn called") return darg df_fn(1) fn(1) assert_type(fn(1), int) if TYPE_CHECKING: # type error - correct fn(1, 2) # type: ignore reportCallIssue fn.cache_clear() @overload @cache def fn_overload(arg: int) -> int: ... @overload @cache def fn_overload(arg: str) -> str: ... @cache def fn_overload(arg: int | str) -> int | str: return arg fn_overload(1) fn_overload("1") # behaves same as previous cache, merges overloads assert_type(fn_overload(1), int | str) assert_type(fn_overload("1"), int | str) fn_overload.cache_clear() if TYPE_CHECKING: # type error - correct fn_overload(frozenset({1,2})) # type: ignore reportCallIssue class Unhashable: @override def __eq__(self, value: object) -> bool: return False @cache def no_cache(arg: Unhashable, arg2: int) -> None: pass if TYPE_CHECKING: no_cache(Unhashable(), 2) # type: ignore reportCallIssue To do this I've defined overloads for cache/lru_cache that are constrained by the signature of the function they're called with. This assumes self as a first parameter is an object method, cls is a classmethod and everything else is either a static method or a function. Then direct each overload to a descriptor protocol that mirrors the binding behaviour of methods/functions/classmethods. The returned type is then a union with a callable that takes arbitrary arguments that are hashable. This means that the previous hashable requirement is retained (type checkers don't know which type was returned so calls must satisfy both, the union takes any arguments as long as they're hashable while the descriptor protocol mirrors the cached function's behaviour).
Open Graph Description: My (second - #12945 my comments there aren't really relevant) attempt at fixing the cache & lru_cache typing problem. This is based on a local wrapper I wrote using newer generics syntax, s...
X Description: My (second - #12945 my comments there aren't really relevant) attempt at fixing the cache & lru_cache typing problem. This is based on a local wrapper I wrote using newer generics s...
Opengraph URL: https://github.com/python/typeshed/pull/12952
X: @github
Domain: github.com
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:f3605e3f-fab0-d848-afa4-b8c6c0036ac9 |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | 83B0:D064:20C1A22:2C6B6C8:6B001D0B |
| html-safe-nonce | ce720f287c9b4e1e8adf4aabf9ebb446718b6c592a98e73c262dfee0d33878a8 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4M0IwOkQwNjQ6MjBDMUEyMjoyQzZCNkM4OjZCMDAxRDBCIiwidmlzaXRvcl9pZCI6IjY2NTAyNjk5MzA2MTg4ODc0MzUiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 449124b8ca78242d904b1d9dc4f386a9008477fd1d58628eb7e177077515f099 |
| hovercard-subject-tag | pull_request:2161739668 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/python/typeshed/pull/12952/files |
| twitter:image | https://avatars.githubusercontent.com/u/10211004?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/10211004?s=400&v=4 |
| og:image:alt | My (second - #12945 my comments there aren't really relevant) attempt at fixing the cache & lru_cache typing problem. This is based on a local wrapper I wrote using newer generics syntax, s... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | 4eb4cba0d69f045374ac15de9666d22b0961e1d555cc3824f36b7734c00c78e0 |
| turbo-cache-control | no-preview |
| diff-view | unified |
| go-import | github.com/python/typeshed git https://github.com/python/typeshed.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 31696383 |
| octolytics-dimension-repository_nwo | python/typeshed |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 31696383 |
| octolytics-dimension-repository_network_root_nwo | python/typeshed |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 44c658b24abf00491fb7ae5f56d42c9f38cbeab2 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width