René's URL Explorer Experiment


Title: emit attribute/variable docstrings · Issue #21645 · python/mypy · GitHub

Open Graph Title: emit attribute/variable docstrings · Issue #21645 · python/mypy

X Title: emit attribute/variable docstrings · Issue #21645 · python/mypy

Description: Feature stubgen --include-docstrings currently emits module, class, and function/method docstrings, but drops attribute (variable) docstrings — the string literal immediately following a variable assignment (PEP 224-style), which Pyright...

Open Graph Description: Feature stubgen --include-docstrings currently emits module, class, and function/method docstrings, but drops attribute (variable) docstrings — the string literal immediately following a variable a...

X Description: Feature stubgen --include-docstrings currently emits module, class, and function/method docstrings, but drops attribute (variable) docstrings — the string literal immediately following a variable a...

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

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"emit attribute/variable docstrings","articleBody":"**Feature**\n\nstubgen --include-docstrings currently emits module, class, and function/method docstrings, but drops attribute (variable) docstrings — the string literal immediately following a variable assignment (PEP 224-style), which Pyright/Pylance read for hover and completion docs. I'd like --include-docstrings to also carry these through into the generated .pyi, for module-level variables, class/instance attributes, dataclass fields, and TypedDict items.\n\n**Pitch**\n\nminimal repro on mypy 2.1.0:\n\nclass ResourceAttrs(TypedDict, total=False):\n    \"\"\"Shared resource attributes.\"\"\"\n    name: NotRequired[str]\n    \"\"\"Resource name.\"\"\"\nActual: the field docstring is dropped; only the class docstring survives.\nExpected: the \"\"\"Resource name.\"\"\" line is preserved under name:.\n\nWhy it matters: attribute docstrings are the standard, tool-supported way to document TypedDict/dataclass/class fields; when a project ships a stub-only package built by stubgen, all per-field docs are silently lost even though the source has them.  In my case, I am trying to build stubs for type completion on kwargs in an IDE like VS Code.  I am trying to better document kwargs where they have been used historically, and with the full source code the IDE can tooltip the class property docstrings on hover (hover over the name key above shows \"Resource name.\", but this could be a more detailed docstring explaining the usage and impact of each keyword argument in the kwargs.\n\n**Workaround**:  class property documentation could be bubbled up into the class docstring, but this can be a bit more overwhelming as kwargs grows.\n\nContext: this is the unfinished \"members\" part of #11965 (closed by #13284, which did module/class/function only). Related: #16114, #16543, #17200, #17964.\n","author":{"url":"https://github.com/JLowe-N","@type":"Person","name":"JLowe-N"},"datePublished":"2026-06-24T20:23:43Z","url":"https://github.com/python/mypy/issues/21645"}

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:8cbfaf8a-12de-90dd-ba5b-4245ebcd4446
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-id9BC6:28B491:319691:3FBF78:6AFFC727
html-safe-nonce9a92644c9b7e7ec34a3ef15608f1cc1480d20a04973c0a7e3b59f33e1a1e8c9c
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5QkM2OjI4QjQ5MTozMTk2OTE6M0ZCRjc4OjZBRkZDNzI3IiwidmlzaXRvcl9pZCI6IjU0ODU3NDAxNDMwMjMyMTIzMjciLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmac366a963a2122764f11bdcbdb9ed02974c1ad95d8397319dfd3c7a9e58663f16c
hovercard-subject-tagissue:4738162481
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/21645/issue_layout
twitter:imagehttps://opengraph.githubassets.com/59cb010909b58de244c6d926fe3bf575784a5c4abd886ab2912de88d156bb525/python/mypy/issues/21645
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/59cb010909b58de244c6d926fe3bf575784a5c4abd886ab2912de88d156bb525/python/mypy/issues/21645
og:image:altFeature stubgen --include-docstrings currently emits module, class, and function/method docstrings, but drops attribute (variable) docstrings — the string literal immediately following a variable a...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernameJLowe-N
hostnamegithub.com
expected-hostnamegithub.com
None1e805b832df235bb21305db712c3b6432920019dfc12cb25b9cb8d3b0c9403cf
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
release8fa4a54e6871c7908eda1c246ad5972982c0b59d
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/python/mypy/issues/21645#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython%2Fmypy%2Fissues%2F21645
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%2F21645
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/21645
Reloadhttps://github.com/python/mypy/issues/21645
Reloadhttps://github.com/python/mypy/issues/21645
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 requests547 (547)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/21645
New issuehttps://github.com/login?return_to=https://github.com/python/mypy/issues/21645
emit attribute/variable docstringshttps://github.com/python/mypy/issues/21645#top
featurehttps://github.com/python/mypy/issues?q=state%3Aopen%20label%3A%22feature%22
topic-stubgenhttps://github.com/python/mypy/issues?q=state%3Aopen%20label%3A%22topic-stubgen%22
https://github.com/JLowe-N
JLowe-Nhttps://github.com/JLowe-N
on Jun 24, 2026https://github.com/python/mypy/issues/21645#issue-4738162481
#11965https://github.com/python/mypy/issues/11965
#13284https://github.com/python/mypy/pull/13284
#16114https://github.com/python/mypy/issues/16114
#16543https://github.com/python/mypy/issues/16543
#17200https://github.com/python/mypy/issues/17200
#17964https://github.com/python/mypy/pull/17964
JLowe-Nhttps://github.com/JLowe-N
featurehttps://github.com/python/mypy/issues?q=state%3Aopen%20label%3A%22feature%22
on Jun 24, 2026https://github.com/python/mypy/issues/21645#event-27164201527
A5rockshttps://github.com/A5rocks
topic-stubgenhttps://github.com/python/mypy/issues?q=state%3Aopen%20label%3A%22topic-stubgen%22
on Jun 26, 2026https://github.com/python/mypy/issues/21645#event-27233205265
Sign up for freehttps://github.com/signup?return_to=https://github.com/python/mypy/issues/21645
Sign in to commenthttps://github.com/login?return_to=https://github.com/python/mypy/issues/21645
featurehttps://github.com/python/mypy/issues?q=state%3Aopen%20label%3A%22feature%22
topic-stubgenhttps://github.com/python/mypy/issues?q=state%3Aopen%20label%3A%22topic-stubgen%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.