René's URL Explorer Experiment


Title: Convert more examples to doctests in `typing` module · Issue #112194 · python/cpython · GitHub

Open Graph Title: Convert more examples to doctests in `typing` module · Issue #112194 · python/cpython

X Title: Convert more examples to doctests in `typing` module · Issue #112194 · python/cpython

Description: Feature or enhancement There are multiple examples that are very similar to doctests, but are not doctests. I propose adding >>> and ... to them, so these examples would be checked during tests (since now we have this feature). There are...

Open Graph Description: Feature or enhancement There are multiple examples that are very similar to doctests, but are not doctests. I propose adding >>> and ... to them, so these examples would be checked during tests (si...

X Description: Feature or enhancement There are multiple examples that are very similar to doctests, but are not doctests. I propose adding >>> and ... to them, so these examples would be checked during ...

Opengraph URL: https://github.com/python/cpython/issues/112194

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Convert more examples to doctests in `typing` module","articleBody":"# Feature or enhancement\r\n\r\nThere are multiple examples that are very similar to doctests, but are not doctests.\r\nI propose adding `\u003e\u003e\u003e` and `...` to them, so these examples would be checked during tests (since now we have this feature).\r\n\r\nThere are some easy ones, where just adding `\u003e\u003e\u003e` (and some imports are enough).\r\nThere are also some more complex ones, where some new types / vars are needed, but I don't think it is worth doing, because it will increase the complexity of these examples.\r\n\r\nExamples:\r\n- https://github.com/python/cpython/blob/0ee2d77331f2362fcaab20cc678530b18e467e3c/Lib/typing.py#L207-L217\r\n- https://github.com/python/cpython/blob/0ee2d77331f2362fcaab20cc678530b18e467e3c/Lib/typing.py#L252-L259\r\n- https://github.com/python/cpython/blob/0ee2d77331f2362fcaab20cc678530b18e467e3c/Lib/typing.py#L672-L686\r\n- https://github.com/python/cpython/blob/0ee2d77331f2362fcaab20cc678530b18e467e3c/Lib/typing.py#L2239-L2255\r\n- https://github.com/python/cpython/blob/0ee2d77331f2362fcaab20cc678530b18e467e3c/Lib/typing.py#L2268-L2280\r\n- https://github.com/python/cpython/blob/0ee2d77331f2362fcaab20cc678530b18e467e3c/Lib/typing.py#L2293-L2304\r\n- https://github.com/python/cpython/blob/0ee2d77331f2362fcaab20cc678530b18e467e3c/Lib/typing.py#L2899-L2909\r\n\r\nThis actually reveals a bug:\r\n\r\nhttps://github.com/python/cpython/blob/0ee2d77331f2362fcaab20cc678530b18e467e3c/Lib/typing.py#L207-L219\r\n\r\n`assert collections.abc.Callable[ParamSpec, str].__args__ == (ParamSpec, str)` example is invalid:\r\n\r\n```\r\nFile \"/Users/sobolev/Desktop/cpython2/Lib/typing.py\", line 218, in typing._should_unflatten_callable_args\r\nFailed example:\r\n    assert collections.abc.Callable[ParamSpec, str].__args__ == (ParamSpec, str)\r\nException raised:\r\n    Traceback (most recent call last):\r\n      File \"/Users/sobolev/Desktop/cpython2/Lib/doctest.py\", line 1374, in __run\r\n        exec(compile(example.source, filename, \"single\",\r\n      File \"\u003cdoctest typing._should_unflatten_callable_args[2]\u003e\", line 1, in \u003cmodule\u003e\r\n        assert collections.abc.Callable[ParamSpec, str].__args__ == (ParamSpec, str)\r\n               ~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^\r\n      File \"/Users/sobolev/Desktop/cpython2/Lib/_collections_abc.py\", line 477, in __new__\r\n        raise TypeError(f\"Expected a list of types, an ellipsis, \"\r\n    TypeError: Expected a list of types, an ellipsis, ParamSpec, or Concatenate. Got \u003cclass 'typing.ParamSpec'\u003e\r\n```\r\n\r\n\u003c!-- gh-linked-prs --\u003e\r\n### Linked PRs\r\n* gh-112195\r\n* gh-112208\n* gh-112209\n\u003c!-- /gh-linked-prs --\u003e\r\n","author":{"url":"https://github.com/sobolevn","@type":"Person","name":"sobolevn"},"datePublished":"2023-11-17T09:49:39.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/112194/cpython/issues/112194"}

route-pattern/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:1c68c2f3-077a-ba8a-81f8-e53812802b33
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idB8BA:74E61:1CD0A0F:28881C6:696A56EB
html-safe-noncec31becbdc3bf10ff4c937e1ac7cc0854bdd62f0cfa3aa5384bf7b830d2510bf3
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCOEJBOjc0RTYxOjFDRDBBMEY6Mjg4ODFDNjo2OTZBNTZFQiIsInZpc2l0b3JfaWQiOiI4NDM2MjQwMTEyNDk5MTg1Mzg3IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0=
visitor-hmace170f6e4f44f1e4d3f0984c809398df685abdf44853a7f4ff0f21e1c923f9939
hovercard-subject-tagissue:1998709072
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/cpython/112194/issue_layout
twitter:imagehttps://opengraph.githubassets.com/d4f2e0b757451f49127ab6f5cfdce156e2139563adf0079298f109b1815ef3ad/python/cpython/issues/112194
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/d4f2e0b757451f49127ab6f5cfdce156e2139563adf0079298f109b1815ef3ad/python/cpython/issues/112194
og:image:altFeature or enhancement There are multiple examples that are very similar to doctests, but are not doctests. I propose adding >>> and ... to them, so these examples would be checked during tests (si...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernamesobolevn
hostnamegithub.com
expected-hostnamegithub.com
None3f871c8e07f0ae1886fa8dac284166d28b09ad5bada6476fc10b674e489788ef
turbo-cache-controlno-preview
go-importgithub.com/python/cpython git https://github.com/python/cpython.git
octolytics-dimension-user_id1525981
octolytics-dimension-user_loginpython
octolytics-dimension-repository_id81598961
octolytics-dimension-repository_nwopython/cpython
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id81598961
octolytics-dimension-repository_network_root_nwopython/cpython
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
release63c426b30d262aba269ef14c40e3c817b384cd61
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/python/cpython/issues/112194#start-of-content
https://github.com/
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython%2Fcpython%2Fissues%2F112194
GitHub CopilotWrite better code with AIhttps://github.com/features/copilot
GitHub SparkBuild and deploy intelligent appshttps://github.com/features/spark
GitHub ModelsManage and compare promptshttps://github.com/features/models
MCP RegistryNewIntegrate external toolshttps://github.com/mcp
ActionsAutomate any workflowhttps://github.com/features/actions
CodespacesInstant dev environmentshttps://github.com/features/codespaces
IssuesPlan and track workhttps://github.com/features/issues
Code ReviewManage code changeshttps://github.com/features/code-review
GitHub Advanced SecurityFind and fix vulnerabilitieshttps://github.com/security/advanced-security
Code securitySecure your code as you buildhttps://github.com/security/advanced-security/code-security
Secret protectionStop leaks before they starthttps://github.com/security/advanced-security/secret-protection
Why GitHubhttps://github.com/why-github
Documentationhttps://docs.github.com
Bloghttps://github.blog
Changeloghttps://github.blog/changelog
Marketplacehttps://github.com/marketplace
View all featureshttps://github.com/features
Enterpriseshttps://github.com/enterprise
Small and medium teamshttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
App Modernizationhttps://github.com/solutions/use-case/app-modernization
DevSecOpshttps://github.com/solutions/use-case/devsecops
DevOpshttps://github.com/solutions/use-case/devops
CI/CDhttps://github.com/solutions/use-case/ci-cd
View all use caseshttps://github.com/solutions/use-case
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
View all industrieshttps://github.com/solutions/industry
View all solutionshttps://github.com/solutions
AIhttps://github.com/resources/articles?topic=ai
Software Developmenthttps://github.com/resources/articles?topic=software-development
DevOpshttps://github.com/resources/articles?topic=devops
Securityhttps://github.com/resources/articles?topic=security
View all topicshttps://github.com/resources/articles
Customer storieshttps://github.com/customer-stories
Events & webinarshttps://github.com/resources/events
Ebooks & reportshttps://github.com/resources/whitepapers
Business insightshttps://github.com/solutions/executive-insights
GitHub Skillshttps://skills.github.com
Documentationhttps://docs.github.com
Customer supporthttps://support.github.com
Community forumhttps://github.com/orgs/community/discussions
Trust centerhttps://github.com/trust-center
Partnershttps://github.com/partners
GitHub SponsorsFund open source developershttps://github.com/sponsors
Security Labhttps://securitylab.github.com
Maintainer Communityhttps://maintainers.github.com
Acceleratorhttps://github.com/accelerator
Archive Programhttps://archiveprogram.github.com
Topicshttps://github.com/topics
Trendinghttps://github.com/trending
Collectionshttps://github.com/collections
Enterprise platformAI-powered developer platformhttps://github.com/enterprise
GitHub Advanced SecurityEnterprise-grade security featureshttps://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/premium-support
Pricinghttps://github.com/pricing
Search syntax tipshttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
documentationhttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython%2Fcpython%2Fissues%2F112194
Sign up https://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%2Fcpython
Reloadhttps://github.com/python/cpython/issues/112194
Reloadhttps://github.com/python/cpython/issues/112194
Reloadhttps://github.com/python/cpython/issues/112194
python https://github.com/python
cpythonhttps://github.com/python/cpython
Please reload this pagehttps://github.com/python/cpython/issues/112194
Notifications https://github.com/login?return_to=%2Fpython%2Fcpython
Fork 33.9k https://github.com/login?return_to=%2Fpython%2Fcpython
Star 71.1k https://github.com/login?return_to=%2Fpython%2Fcpython
Code https://github.com/python/cpython
Issues 5k+ https://github.com/python/cpython/issues
Pull requests 2.1k https://github.com/python/cpython/pulls
Actions https://github.com/python/cpython/actions
Projects 31 https://github.com/python/cpython/projects
Security Uh oh! There was an error while loading. Please reload this page. https://github.com/python/cpython/security
Please reload this pagehttps://github.com/python/cpython/issues/112194
Insights https://github.com/python/cpython/pulse
Code https://github.com/python/cpython
Issues https://github.com/python/cpython/issues
Pull requests https://github.com/python/cpython/pulls
Actions https://github.com/python/cpython/actions
Projects https://github.com/python/cpython/projects
Security https://github.com/python/cpython/security
Insights https://github.com/python/cpython/pulse
New issuehttps://github.com/login?return_to=https://github.com/python/cpython/issues/112194
New issuehttps://github.com/login?return_to=https://github.com/python/cpython/issues/112194
Convert more examples to doctests in typing modulehttps://github.com/python/cpython/issues/112194#top
https://github.com/sobolevn
docsDocumentation in the Doc dirhttps://github.com/python/cpython/issues?q=state%3Aopen%20label%3A%22docs%22
testsTests in the Lib/test dirhttps://github.com/python/cpython/issues?q=state%3Aopen%20label%3A%22tests%22
topic-typinghttps://github.com/python/cpython/issues?q=state%3Aopen%20label%3A%22topic-typing%22
type-featureA feature request or enhancementhttps://github.com/python/cpython/issues?q=state%3Aopen%20label%3A%22type-feature%22
https://github.com/sobolevn
https://github.com/sobolevn
sobolevnhttps://github.com/sobolevn
on Nov 17, 2023https://github.com/python/cpython/issues/112194#issue-1998709072
cpython/Lib/typing.pyhttps://github.com/python/cpython/blob/0ee2d77331f2362fcaab20cc678530b18e467e3c/Lib/typing.py#L207-L217
0ee2d77https://github.com/python/cpython/commit/0ee2d77331f2362fcaab20cc678530b18e467e3c
cpython/Lib/typing.pyhttps://github.com/python/cpython/blob/0ee2d77331f2362fcaab20cc678530b18e467e3c/Lib/typing.py#L252-L259
0ee2d77https://github.com/python/cpython/commit/0ee2d77331f2362fcaab20cc678530b18e467e3c
cpython/Lib/typing.pyhttps://github.com/python/cpython/blob/0ee2d77331f2362fcaab20cc678530b18e467e3c/Lib/typing.py#L672-L686
0ee2d77https://github.com/python/cpython/commit/0ee2d77331f2362fcaab20cc678530b18e467e3c
cpython/Lib/typing.pyhttps://github.com/python/cpython/blob/0ee2d77331f2362fcaab20cc678530b18e467e3c/Lib/typing.py#L2239-L2255
0ee2d77https://github.com/python/cpython/commit/0ee2d77331f2362fcaab20cc678530b18e467e3c
cpython/Lib/typing.pyhttps://github.com/python/cpython/blob/0ee2d77331f2362fcaab20cc678530b18e467e3c/Lib/typing.py#L2268-L2280
0ee2d77https://github.com/python/cpython/commit/0ee2d77331f2362fcaab20cc678530b18e467e3c
cpython/Lib/typing.pyhttps://github.com/python/cpython/blob/0ee2d77331f2362fcaab20cc678530b18e467e3c/Lib/typing.py#L2293-L2304
0ee2d77https://github.com/python/cpython/commit/0ee2d77331f2362fcaab20cc678530b18e467e3c
cpython/Lib/typing.pyhttps://github.com/python/cpython/blob/0ee2d77331f2362fcaab20cc678530b18e467e3c/Lib/typing.py#L2899-L2909
0ee2d77https://github.com/python/cpython/commit/0ee2d77331f2362fcaab20cc678530b18e467e3c
cpython/Lib/typing.pyhttps://github.com/python/cpython/blob/0ee2d77331f2362fcaab20cc678530b18e467e3c/Lib/typing.py#L207-L219
0ee2d77https://github.com/python/cpython/commit/0ee2d77331f2362fcaab20cc678530b18e467e3c
gh-112194: Convert more examples to doctests in typing.py #112195https://github.com/python/cpython/pull/112195
[3.12] gh-112194: Convert more examples to doctests in typing.py (GH-112195) #112208https://github.com/python/cpython/pull/112208
[3.11] gh-112194: Convert more examples to doctests in typing.py (GH-112195) #112209https://github.com/python/cpython/pull/112209
sobolevnhttps://github.com/sobolevn
docsDocumentation in the Doc dirhttps://github.com/python/cpython/issues?q=state%3Aopen%20label%3A%22docs%22
testsTests in the Lib/test dirhttps://github.com/python/cpython/issues?q=state%3Aopen%20label%3A%22tests%22
topic-typinghttps://github.com/python/cpython/issues?q=state%3Aopen%20label%3A%22topic-typing%22
type-featureA feature request or enhancementhttps://github.com/python/cpython/issues?q=state%3Aopen%20label%3A%22type-feature%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.