Title: Change `cache`/`lru_cache` typing to retain function signatures by alwaysmpe · Pull Request #12945 · python/typeshed · GitHub
Open Graph Title: Change `cache`/`lru_cache` typing to retain function signatures by alwaysmpe · Pull Request #12945 · python/typeshed
X Title: Change `cache`/`lru_cache` typing to retain function signatures by alwaysmpe · Pull Request #12945 · python/typeshed
Description: My attempt at fixing the cache & lru_cache typing problem. Using the newer generics syntax I get the same result in both mypy and pyright. Using the older typevar syntax (which I'm less familiar with) I get different errors. See my comment for the newer generics approach. Using these type stubs in pyright the below code checks as expected, mypy thinks some of the type invariance should be different (update: I've pushed changes to match mypy's preference) Update: think I've worked it out, converting to draft while making changes. from functools import cache 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) CFnCls.st_fn(1) CFnCls.cls_fn(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: CFnCls().fn(1, 1) # type error - correct CFnCls.st_fn(1, 1) # type error - correct CFnCls.cls_fn(1, 1) # type error - correct @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: fn(1, 2) # type error - correct 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: fn_overload({1,2}) # type error - correct class Unhashable: @override def __eq__(self, value: object) -> bool: return False @cache def no_cache(arg: Unhashable, arg2: int) -> None: pass if TYPE_CHECKING: # type error in pyright - correct # no type error in mypy? no_cache(Unhashable(), 2) Define 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 a function method, cls is a classmethod and everything else are either static methods or functions. 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 attempt at fixing the cache & lru_cache typing problem. Using the newer generics syntax I get the same result in both mypy and pyright. Using the older typevar syntax (which I'm less fam...
X Description: My attempt at fixing the cache & lru_cache typing problem. Using the newer generics syntax I get the same result in both mypy and pyright. Using the older typevar syntax (which I'm ...
Opengraph URL: https://github.com/python/typeshed/pull/12945
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:2b5c39a2-57d3-1dfe-0000-5563a2c5fd26 |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | 9C6A:4D728:31FE9C1:41FE4B6:6B00303F |
| html-safe-nonce | d210faed4b804b2090faa34925b8de895c2a52a8f75436c011a0ce79be1de3ba |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5QzZBOjRENzI4OjMxRkU5QzE6NDFGRTRCNjo2QjAwMzAzRiIsInZpc2l0b3JfaWQiOiIyNzE5NTg1NDM5Nzg5ODg3NTUxIiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 5193525cc9de09b4c355458ac534135121bfa29360317b8f91cc63123fbaa301 |
| hovercard-subject-tag | pull_request:2159536749 |
| 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/12945/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 attempt at fixing the cache & lru_cache typing problem. Using the newer generics syntax I get the same result in both mypy and pyright. Using the older typevar syntax (which I'm less fam... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | 7d0829bbde9e48b2486cb5dd6d147896eb01d32134627091f818958a935ef3f0 |
| 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 | f3f3a43ca095cdea3abbb394112e971f9fdb94fa |
| ui-target | canary-1 |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width