René's URL Explorer Experiment


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

direct link

Domain: github.com

react-profiling0
react-import-mapreact,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-controllerpull_requests
route-actionfiles
fetch-noncev2:f3605e3f-fab0-d848-afa4-b8c6c0036ac9
current-catalog-service-hashae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b
request-id83B0:D064:20C1A22:2C6B6C8:6B001D0B
html-safe-noncece720f287c9b4e1e8adf4aabf9ebb446718b6c592a98e73c262dfee0d33878a8
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4M0IwOkQwNjQ6MjBDMUEyMjoyQzZCNkM4OjZCMDAxRDBCIiwidmlzaXRvcl9pZCI6IjY2NTAyNjk5MzA2MTg4ODc0MzUiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmac449124b8ca78242d904b1d9dc4f386a9008477fd1d58628eb7e177077515f099
hovercard-subject-tagpull_request:2161739668
github-keyboard-shortcutsrepository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///pull_requests/show/files
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/python/typeshed/pull/12952/files
twitter:imagehttps://avatars.githubusercontent.com/u/10211004?s=400&v=4
twitter:cardsummary_large_image
og:imagehttps://avatars.githubusercontent.com/u/10211004?s=400&v=4
og:image:altMy (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_nameGitHub
og:typeobject
hostnamegithub.com
expected-hostnamegithub.com
None4eb4cba0d69f045374ac15de9666d22b0961e1d555cc3824f36b7734c00c78e0
turbo-cache-controlno-preview
diff-viewunified
go-importgithub.com/python/typeshed git https://github.com/python/typeshed.git
octolytics-dimension-user_id1525981
octolytics-dimension-user_loginpython
octolytics-dimension-repository_id31696383
octolytics-dimension-repository_nwopython/typeshed
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id31696383
octolytics-dimension-repository_network_root_nwopython/typeshed
turbo-body-classeslogged-out env-production page-responsive
disable-turbotrue
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release44c658b24abf00491fb7ae5f56d42c9f38cbeab2
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/python/typeshed/pull/12952/files#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython%2Ftypeshed%2Fpull%2F12952%2Ffiles
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython%2Ftypeshed%2Fpull%2F12952%2Ffiles
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fpull_requests%2Fshow%2Ffiles&source=header-repo&source_repo=python%2Ftypeshed
Reloadhttps://github.com/python/typeshed/pull/12952/files
Reloadhttps://github.com/python/typeshed/pull/12952/files
Reloadhttps://github.com/python/typeshed/pull/12952/files
pythonhttps://github.com/python
typeshedhttps://github.com/python/typeshed
Codehttps://github.com/python/typeshed
Issues196 (196)https://github.com/python/typeshed/issues
Pull requests251 (251)https://github.com/python/typeshed/pulls
Actionshttps://github.com/python/typeshed/actions
Security and qualityhttps://github.com/python/typeshed/security
Insightshttps://github.com/python/typeshed/insights
Sign up for GitHub https://github.com/signup?return_to=%2Fpython%2Ftypeshed%2Fissues%2Fnew%2Fchoose
terms of servicehttps://docs.github.com/terms
privacy statementhttps://docs.github.com/privacy
Sign inhttps://github.com/login?return_to=%2Fpython%2Ftypeshed%2Fissues%2Fnew%2Fchoose
alwaysmpehttps://github.com/alwaysmpe
python:mainhttps://github.com/python/typeshed/tree/main
alwaysmpe:cache_typinghttps://github.com/alwaysmpe/typeshed/tree/cache_typing
Conversation 4 https://github.com/python/typeshed/pull/12952
Commits 1 https://github.com/python/typeshed/pull/12952/commits
Checks 0 https://github.com/python/typeshed/pull/12952/checks
Files changed https://github.com/python/typeshed/pull/12952/files
Please reload this pagehttps://github.com/python/typeshed/pull/12952/files
Change cache/lru_cache typing to retain function signatures https://github.com/python/typeshed/pull/12952/files#top
Show all changes 1 commit https://github.com/python/typeshed/pull/12952/files
2874459 Change `cache`/`lru_cache` typing to retain function signatures alwaysmpe Nov 4, 2024 https://github.com/python/typeshed/pull/12952/commits/2874459a3555bb2f41a60b9541d005cd2b55eaa7
Clear filters https://github.com/python/typeshed/pull/12952/files
Please reload this pagehttps://github.com/python/typeshed/pull/12952/files
Please reload this pagehttps://github.com/python/typeshed/pull/12952/files
stdlib/functools.pyihttps://github.com/python/typeshed/pull/12952/files#diff-02c51ed45b741b6765c365fb5d6578c586510bbbd57b10a1dba10aeba37ae157
View file https://github.com/alwaysmpe/typeshed/blob/2874459a3555bb2f41a60b9541d005cd2b55eaa7/stdlib/functools.pyi
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/python/typeshed/pull/12952/{{ revealButtonHref }}
https://github.com/python/typeshed/pull/12952/files#diff-02c51ed45b741b6765c365fb5d6578c586510bbbd57b10a1dba10aeba37ae157
https://github.com/python/typeshed/pull/12952/files#diff-02c51ed45b741b6765c365fb5d6578c586510bbbd57b10a1dba10aeba37ae157
https://github.com/python/typeshed/pull/12952/files#diff-02c51ed45b741b6765c365fb5d6578c586510bbbd57b10a1dba10aeba37ae157
https://github.com/python/typeshed/pull/12952/files#diff-02c51ed45b741b6765c365fb5d6578c586510bbbd57b10a1dba10aeba37ae157
https://github.com/python/typeshed/pull/12952/files#diff-02c51ed45b741b6765c365fb5d6578c586510bbbd57b10a1dba10aeba37ae157
https://github.com/python/typeshed/pull/12952/files#diff-02c51ed45b741b6765c365fb5d6578c586510bbbd57b10a1dba10aeba37ae157
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.