René's URL Explorer Experiment


Title: tracking module name overriding · Issue #16758 · python/mypy · GitHub

Open Graph Title: tracking module name overriding · Issue #16758 · python/mypy

X Title: tracking module name overriding · Issue #16758 · python/mypy

Description: Feature I'm interested in adding functionality so that mypy will track modules that rename themselves with an explicit __name__, and classes which set an explicit __module__ value. This would then show up in user-facing messages and also...

Open Graph Description: Feature I'm interested in adding functionality so that mypy will track modules that rename themselves with an explicit __name__, and classes which set an explicit __module__ value. This would then ...

X Description: Feature I'm interested in adding functionality so that mypy will track modules that rename themselves with an explicit __name__, and classes which set an explicit __module__ value. This would t...

Opengraph URL: https://github.com/python/mypy/issues/16758

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"tracking module name overriding","articleBody":"**Feature**\r\n\r\nI'm interested in adding functionality so that mypy will track modules that rename themselves with an explicit `__name__`, and classes which set an explicit `__module__` value. This would then show up in user-facing messages and also affect tooling like stubgen / stubtest. The general motivation is aligning more closely with runtime this way.\r\n\r\n**Pitch**\r\n\r\nSome discussion of this has already occurred in this typeshed issue: https://github.com/python/typeshed/issues/11141\r\n\r\nAnd I made a quick proof-of-concept implementation of class-based `__module__` tracking. The implementation is not very polished, and not necessarily what I'd like to pursue, but it *does* work: https://github.com/python/mypy/pull/16698\r\n\r\nImplementing module-level `__name__` tracking would require a bigger change, I think, mostly focused on the `fullname` attribute of classes in `mypy/nodes.py`. I'm new to the mypy codebase, but after spending some time poking around my general idea right now is something like this:\r\n\r\nRight now, a bunch of the node classes keep a `_fullname` attribute, accessible via the `fullname` property. I think I can split that into three values: qualname, module_name, and module_id, where module_id is what mypy currently uses, and module_name is usually the same as module_id but can be modified by `__name__` and `__module__` values. Then the `fullname` property can be generated on demand, and the static module_id is still available for lookup purposes when it's needed.\r\n\r\nI saw that the switch from `.fullname()` methods to the `.fullname` property was a concern for API stability, so I'm trying to be mindful of this. I think it can be done in a way that mostly affects places that currently set `._fullname` values during semantic analysis, without affecting read-only uses of `.fullname`. `SemanticAnalyzer.qualified_name()` would probably be affected too, but I don't fully understand all the quirks of that, and I'm pretty sure there's specific situations it's carefully designed for that I don't know to think about yet.\r\n\r\nThe far end of the effort scale, this could include avoiding reliance on module_id more broadly. Currently it seems key to `local_definitions()`, where the alternative would probably be explicit tracking of what was added to a scope by an import statement. It also seems important to incremental features and lookup related functionality, neither of which I have a great grasp on at the moment. I'm not sure what those could look like without relying on module_id to match the file name and not change. It's probably more disruptive than it's worth. Changing `fullname` to use `module_name` instead of `module_id` is appealing to me, but probably also disruptive for not much actual gain.\r\n\r\nAt the low end of the effort scale would be not implementing module-level `__name__` tracking at all, and sticking with just class-level `__module__` tracking. That's relatively simple (see the MR I linked earlier), and gets most of the actual functionality that I'm looking for, at the cost of additional duplication in typeshed stubs and lack of support for adjusting the fullname of anything other than classes.\r\n\r\nThere's probably also a possible implementation that does cover module-level `__name__` tracking, but avoids touching anything about the current `._fullname` or `.fullname` attributes. That looks something like that draft MR I linked above, but expanded to cover `MypyFile` and other `SymbolNode` subclasses, with appropriate adjustments to `SemanticAnalyzer` to propagate the `module_override` value as needed.\r\n\r\nOverall the benefits are... let's say modest. Some user-facing messaging could improve it's fidelity with runtime naming, once typeshed was updated to include these definitions, and some parts of stubtest could get a little better. Typeshed could more closely mirror runtime in certain respects.\r\n\r\nI started thinking about this after working on some cleanups in typeshed. I got even more interested in this work after I started looking at the work of splitting `collections.abc` classes from their aliases in `typing`. Runtime keeps these implementations in `_collections_abc.py` for performance reasons, with a module-level `__name__ = \"collections.abc\"` set. It'd be nice if typeshed could do the same; I think it's better for resolving the cycle that includes typing and builtins than having those in `collections/abc.pyi` would be? But I'm not sure I'm reasoning about that correctly.\r\n\r\nAll that said, what do mypy maintainers think?\r\n\r\n a) Is this a reasonable idea to pursue?\r\n\r\n b) is the idea of splitting up the internal `._fullname` a reasonable way to do it or am I missing something that would make that impractical or too disruptive?","author":{"url":"https://github.com/tungol","@type":"Person","name":"tungol"},"datePublished":"2024-01-07T11:51:48Z","url":"https://github.com/python/mypy/issues/16758"}

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/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:05e792ec-9e01-d962-e3c0-e19bfe9c657c
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idACC4:30501:B478E2:F36386:6B004E66
html-safe-nonceb6a5c8ccb57f975b798cfdf5fef42b363f8961c77b0ad0a4f6df05665576cb67
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBQ0M0OjMwNTAxOkI0NzhFMjpGMzYzODY6NkIwMDRFNjYiLCJ2aXNpdG9yX2lkIjoiNjgxODI5ODg5MTAwODQ5NTIwNiIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9
visitor-hmac5bbc5a8972ebe4c402be99811a334bba0ebb252d84afc7dea59fc8fbc7688854
hovercard-subject-tagissue:2069099221
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python/mypy/16758/issue_layout
twitter:imagehttps://opengraph.githubassets.com/f04cc2c877cdcefc76ff7f94ce2a212978a26f6d4de28853c07ccac1627adc84/python/mypy/issues/16758
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/f04cc2c877cdcefc76ff7f94ce2a212978a26f6d4de28853c07ccac1627adc84/python/mypy/issues/16758
og:image:altFeature I'm interested in adding functionality so that mypy will track modules that rename themselves with an explicit __name__, and classes which set an explicit __module__ value. This would then ...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernametungol
hostnamegithub.com
expected-hostnamegithub.com
Nonef9517bf360d46638a1e5e7daee7158842fe5ef43c9000afa0e127564a7c2f39b
turbo-cache-controlno-preview
go-importgithub.com/python/mypy git https://github.com/python/mypy.git
octolytics-dimension-user_id1525981
octolytics-dimension-user_loginpython
octolytics-dimension-repository_id7053637
octolytics-dimension-repository_nwopython/mypy
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id7053637
octolytics-dimension-repository_network_root_nwopython/mypy
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
releaseb27c5dde30676028abd5c5fc53ce5c9b625f8281
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/python/mypy/issues/16758#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython%2Fmypy%2Fissues%2F16758
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%2Fmypy%2Fissues%2F16758
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=python%2Fmypy
Reloadhttps://github.com/python/mypy/issues/16758
Reloadhttps://github.com/python/mypy/issues/16758
Reloadhttps://github.com/python/mypy/issues/16758
pythonhttps://github.com/python
mypyhttps://github.com/python/mypy
Codehttps://github.com/python/mypy
Issues2.7k (2.7k)https://github.com/python/mypy/issues
Pull requests546 (546)https://github.com/python/mypy/pulls
Actionshttps://github.com/python/mypy/actions
Projectshttps://github.com/python/mypy/projects
Wikihttps://github.com/python/mypy/wiki
Security and qualityhttps://github.com/python/mypy/security
Insightshttps://github.com/python/mypy/insights
https://github.com/python/mypy
New issuehttps://github.com/login?return_to=https://github.com/python/mypy/issues/16758
New issuehttps://github.com/login?return_to=https://github.com/python/mypy/issues/16758
tracking module name overridinghttps://github.com/python/mypy/issues/16758#top
featurehttps://github.com/python/mypy/issues?q=state%3Aopen%20label%3A%22feature%22
https://github.com/tungol
tungolhttps://github.com/tungol
on Jan 7, 2024https://github.com/python/mypy/issues/16758#issue-2069099221
python/typeshed#11141https://github.com/python/typeshed/issues/11141
#16698https://github.com/python/mypy/pull/16698
tungolhttps://github.com/tungol
featurehttps://github.com/python/mypy/issues?q=state%3Aopen%20label%3A%22feature%22
on Jan 7, 2024https://github.com/python/mypy/issues/16758#event-11411064260
tungolhttps://github.com/tungol
completedhttps://github.com/python/mypy/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
on Nov 13, 2024https://github.com/python/mypy/issues/16758#event-15274585482
Sign up for freehttps://github.com/signup?return_to=https://github.com/python/mypy/issues/16758
Sign in to commenthttps://github.com/login?return_to=https://github.com/python/mypy/issues/16758
featurehttps://github.com/python/mypy/issues?q=state%3Aopen%20label%3A%22feature%22
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.