René's URL Explorer Experiment


Title: Should we support type annotations in docstrings for Python 2 code? · Issue #612 · python/mypy · GitHub

Open Graph Title: Should we support type annotations in docstrings for Python 2 code? · Issue #612 · python/mypy

X Title: Should we support type annotations in docstrings for Python 2 code? · Issue #612 · python/mypy

Description: We could support an alternative, docstring-based syntax for types in programs that need to be Python 2 compatible. The idea is from http://sphinxcontrib-napoleon.readthedocs.org/en/latest/example_google.html Example: def first_name(name)...

Open Graph Description: We could support an alternative, docstring-based syntax for types in programs that need to be Python 2 compatible. The idea is from http://sphinxcontrib-napoleon.readthedocs.org/en/latest/example_g...

X Description: We could support an alternative, docstring-based syntax for types in programs that need to be Python 2 compatible. The idea is from http://sphinxcontrib-napoleon.readthedocs.org/en/latest/example_g...

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

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Should we support type annotations in docstrings for Python 2 code?","articleBody":"We could support an alternative, docstring-based syntax for types in programs that need to be Python 2 compatible. The idea is from http://sphinxcontrib-napoleon.readthedocs.org/en/latest/example_google.html\n\nExample:\n\n``` python\ndef first_name(name):\n    \"\"\"Return the first name from a name with both a first and a last name.\n\n    Args:\n      name (str): The full name, such as 'John Smith'.\n\n    Returns:\n      str: The first name.\n    \"\"\"\n    return name.split()[0]\n```\n\nMypy would threat this as equivalent to this:\n\n``` python\ndef first_name(name: str) -> str:\n    return name.split()[0]\n```\n\nA bunch of details would have to be fleshed out before implementing this. I'm adding this issue to get feedback on whether people would consider this useful. I've started seeing code using the above convention (though with slightly ad-hoc types).\n\nNote that we can support `# type:` annotations as an alternative. They could be pretty useful for small, internal functions that may not have a docstring at all. The docstring syntax would be pretty verbose if used for every function. Example:\n\n``` python\ndef first_name(name):  # type: (str) -> str\n    return name.split()[0]\n```\n\nMaybe we should extend the docstring syntax to have optional shorter forms:\n\n``` python\ndef join_name(first_name, last_name):\n    \"\"\"Join first and last name into a full name.\n\n    Args: first_name (str), last_name (str)\n    Returns: str\n    \"\"\"\n    return first_name + ' ' + last_name\n```\n\nAnother shorter form:\n\n``` python\ndef join_name(first_name, last_name):\n    \"\"\"Join first and last name into a full name.\n\n    Args: \n      first_name (str)\n      last_name (str)\n    Returns: str\n    \"\"\"\n    return first_name + ' ' + last_name\n```\n\nAnother alternative for Python 2 code is to use the mypy codec that supports Python 3 type annotations in Python 2 code by automatically stripping them away. This has a few problems:\n1. The codec generally needs to be activated before it can be used, which is a minor pain, especially for entry point / main module(s).\n2. Tools such as IDEs and linters may get confused by it (but they could potentially be used in Python 3 mode, if the code is also Python 3 compatible).\n3. It slows down bytecode compilation or program startup. However, if we'd implement it in C, it could be very fast for CPython. But what about PyPy, Jython etc.?\n","author":{"url":"https://github.com/JukkaL","@type":"Person","name":"JukkaL"},"datePublished":"2015-03-21T05:48:58Z","url":"https://github.com/python/mypy/issues/612"}

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:7fc37f2b-c4ff-1497-e01d-68ab9ec44f83
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idED92:1BAA33:22DFDD7:2E606C8:6B005016
html-safe-nonce5ab166a00780ddd19bc2b9356542167e665fc3a5fbb44ede4c0d383705633e88
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJFRDkyOjFCQUEzMzoyMkRGREQ3OjJFNjA2Qzg6NkIwMDUwMTYiLCJ2aXNpdG9yX2lkIjoiNTA2ODMxMDczODIyMTY4MjcxMCIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9
visitor-hmacf8396b57d607e68f25f3db2e26b7563013a3b4941ba776e3e6d5217e15f3c36d
hovercard-subject-tagissue:63365780
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/612/issue_layout
twitter:imagehttps://opengraph.githubassets.com/2250aaf0826840af9b11b161ee7ffe662fbb2664bdfcdb386e171210feb6f2b8/python/mypy/issues/612
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/2250aaf0826840af9b11b161ee7ffe662fbb2664bdfcdb386e171210feb6f2b8/python/mypy/issues/612
og:image:altWe could support an alternative, docstring-based syntax for types in programs that need to be Python 2 compatible. The idea is from http://sphinxcontrib-napoleon.readthedocs.org/en/latest/example_g...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernameJukkaL
hostnamegithub.com
expected-hostnamegithub.com
Nonef420f4996e6b1ff1ccd6d7683f8134f4b5f0f8a50124c210dbfe7490e5644abb
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
release26e00df917aba0f128135dc073ea0c5e33a70d40
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/python/mypy/issues/612#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython%2Fmypy%2Fissues%2F612
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%2F612
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/612
Reloadhttps://github.com/python/mypy/issues/612
Reloadhttps://github.com/python/mypy/issues/612
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/612
New issuehttps://github.com/login?return_to=https://github.com/python/mypy/issues/612
Should we support type annotations in docstrings for Python 2 code?https://github.com/python/mypy/issues/612#top
needs discussionhttps://github.com/python/mypy/issues?q=state%3Aopen%20label%3A%22needs%20discussion%22
https://github.com/JukkaL
JukkaLhttps://github.com/JukkaL
on Mar 21, 2015https://github.com/python/mypy/issues/612#issue-63365780
http://sphinxcontrib-napoleon.readthedocs.org/en/latest/example_google.htmlhttp://sphinxcontrib-napoleon.readthedocs.org/en/latest/example_google.html
JukkaLhttps://github.com/JukkaL
needs discussionhttps://github.com/python/mypy/issues?q=state%3Aopen%20label%3A%22needs%20discussion%22
on Mar 21, 2015https://github.com/python/mypy/issues/612#event-261019406
https://github.com/refi64
refi64https://github.com/refi64
on Mar 21, 2015https://github.com/python/mypy/issues/612#issuecomment-84411143
https://github.com/JukkaL
JukkaLhttps://github.com/JukkaL
on Mar 21, 2015https://github.com/python/mypy/issues/612#issuecomment-84421324
@kirbyfan64https://github.com/kirbyfan64
https://github.com/refi64
refi64https://github.com/refi64
on Mar 21, 2015https://github.com/python/mypy/issues/612#issuecomment-84423088
@JukkaLhttps://github.com/JukkaL
https://github.com/JukkaL
JukkaLhttps://github.com/JukkaL
on Mar 21, 2015https://github.com/python/mypy/issues/612#issuecomment-84433169
https://github.com/refi64
refi64https://github.com/refi64
on Mar 21, 2015https://github.com/python/mypy/issues/612#issuecomment-84454305
@JukkaLhttps://github.com/JukkaL
https://github.com/presidento
presidentohttps://github.com/presidento
on Jun 1, 2015https://github.com/python/mypy/issues/612#issuecomment-107645380
from PyCharm IDEhttps://www.jetbrains.com/pycharm/help/type-hinting-in-pycharm.html
https://github.com/gvanrossum
gvanrossumhttps://github.com/gvanrossum
on Jan 18, 2016https://github.com/python/mypy/issues/612#issuecomment-172439512
https://github.com/JukkaL
JukkaLhttps://github.com/JukkaL
on Jan 18, 2016https://github.com/python/mypy/issues/612#issuecomment-172481941
JukkaLhttps://github.com/JukkaL
postponedhttps://github.com/python/mypy/issues?q=state%3Aopen%20label%3A%22postponed%22
on Jan 18, 2016https://github.com/python/mypy/issues/612#event-517725656
https://github.com/JukkaL
JukkaLhttps://github.com/JukkaL
on Jan 18, 2016https://github.com/python/mypy/issues/612#issuecomment-172482028
https://github.com/JukkaL
JukkaLhttps://github.com/JukkaL
on Jun 3, 2016https://github.com/python/mypy/issues/612#issuecomment-223466799
https://github.com/gvanrossum
gvanrossumhttps://github.com/gvanrossum
on Jun 3, 2016https://github.com/python/mypy/issues/612#issuecomment-223467302
gvanrossumhttps://github.com/gvanrossum
completedhttps://github.com/python/mypy/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
on Jun 3, 2016https://github.com/python/mypy/issues/612#event-680596139
Sign up for freehttps://github.com/signup?return_to=https://github.com/python/mypy/issues/612
Sign in to commenthttps://github.com/login?return_to=https://github.com/python/mypy/issues/612
needs discussionhttps://github.com/python/mypy/issues?q=state%3Aopen%20label%3A%22needs%20discussion%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.