René's URL Explorer Experiment


Title: Protocol naming convention · Issue #4174 · python/typeshed · GitHub

Open Graph Title: Protocol naming convention · Issue #4174 · python/typeshed

X Title: Protocol naming convention · Issue #4174 · python/typeshed

Description: Now that we have a central stub for common types and protocols, we should think about how we name protocols in typeshed. Currently there is no common convention. Some possible conventions for a "read" protocol: Readable HasRead SupportsR...

Open Graph Description: Now that we have a central stub for common types and protocols, we should think about how we name protocols in typeshed. Currently there is no common convention. Some possible conventions for a "re...

X Description: Now that we have a central stub for common types and protocols, we should think about how we name protocols in typeshed. Currently there is no common convention. Some possible conventions for a &qu...

Opengraph URL: https://github.com/python/typeshed/issues/4174

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Protocol naming convention","articleBody":"Now that we have a central stub for common types and protocols, we should think about how we name protocols in typeshed. Currently there is no common convention. Some possible conventions for a \"read\" protocol:\r\n\r\n* `Readable`\r\n* `HasRead`\r\n* `SupportsRead`\r\n* `IsReadable`\r\n* `Reader`\r\n\r\nI have no strong preferences, but I think the naming to reflect that a class is a protocol. Therefore I'd suggest we should use either, some, or all of the above. The second name (`HasRead`) clearly implies the existence of a field `read`, but would exclude protocols with multiple fields, such as this from `stdlib/3.9/zoneinfo/__init__.pyi`:\r\n\r\n```python\r\nclass _IOBytes(Protocol):\r\n    def read(self, __size: int) -> bytes: ...\r\n    def seek(self, __size: int, __whence: int = ...) -> Any: ...\r\n```\r\nHere is a proposal to start the discussion:\r\n\r\n* Use plain names for protocols that represent a clear concept (e.g. `Iterator`, `Container`).\r\n* Use `SupportsX` for protocols that provide type conversion (e.g. `SupportsInt`).\r\n* Use `Xable` for protocols that provide callable methods (e.g. `Readable`, `LineReadable`, `BytesReadable`, `ReadSeekable`).\r\n* Use `HasX` for protocols that have readable and/or writable attributes or getter/setter methods (e.g. `HasItems`, `HasFileno`).\r\n","author":{"url":"https://github.com/srittau","@type":"Person","name":"srittau"},"datePublished":"2020-06-04T12:40:15Z","url":"https://github.com/python/typeshed/issues/4174"}

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:fa8f320f-da32-a16c-96ca-d0224e1b8d6a
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-id87D2:F5AA9:23C7345:30B4C6A:6B002F73
html-safe-noncea843558e1781e3f40aae44930b9b36f6bdb9158a6ddc5047e2ebde5bc2d4a499
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4N0QyOkY1QUE5OjIzQzczNDU6MzBCNEM2QTo2QjAwMkY3MyIsInZpc2l0b3JfaWQiOiIyNDIxNTQ0NjI4MTg5NjcxMjgzIiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0=
visitor-hmac03a811dd9525ada220fa48d82db8074928eb7113a284d6f1cf7c1043414dacec
hovercard-subject-tagissue:630786437
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/typeshed/4174/issue_layout
twitter:imagehttps://opengraph.githubassets.com/2f5fc5ab81447f2def3ca82c2fad69f1e275a05b3a9668ead88d57fe313aa8c2/python/typeshed/issues/4174
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/2f5fc5ab81447f2def3ca82c2fad69f1e275a05b3a9668ead88d57fe313aa8c2/python/typeshed/issues/4174
og:image:altNow that we have a central stub for common types and protocols, we should think about how we name protocols in typeshed. Currently there is no common convention. Some possible conventions for a "re...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernamesrittau
hostnamegithub.com
expected-hostnamegithub.com
None7d0829bbde9e48b2486cb5dd6d147896eb01d32134627091f818958a935ef3f0
turbo-cache-controlno-preview
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-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
releasef3f3a43ca095cdea3abbb394112e971f9fdb94fa
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/python/typeshed/issues/4174#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython%2Ftypeshed%2Fissues%2F4174
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%2Fissues%2F4174
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%2Ftypeshed
Reloadhttps://github.com/python/typeshed/issues/4174
Reloadhttps://github.com/python/typeshed/issues/4174
Reloadhttps://github.com/python/typeshed/issues/4174
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
https://github.com/python/typeshed
New issuehttps://github.com/login?return_to=https://github.com/python/typeshed/issues/4174
New issuehttps://github.com/login?return_to=https://github.com/python/typeshed/issues/4174
#4229https://github.com/python/typeshed/pull/4229
Protocol naming conventionhttps://github.com/python/typeshed/issues/4174#top
#4229https://github.com/python/typeshed/pull/4229
project: policyOrganization of the typeshed projecthttps://github.com/python/typeshed/issues?q=state%3Aopen%20label%3A%22project%3A%20policy%22
https://github.com/srittau
srittauhttps://github.com/srittau
on Jun 4, 2020https://github.com/python/typeshed/issues/4174#issue-630786437
srittauhttps://github.com/srittau
project: policyOrganization of the typeshed projecthttps://github.com/python/typeshed/issues?q=state%3Aopen%20label%3A%22project%3A%20policy%22
on Jun 4, 2020https://github.com/python/typeshed/issues/4174#event-3406653032
https://github.com/hauntsaninja
hauntsaninjahttps://github.com/hauntsaninja
on Jun 4, 2020https://github.com/python/typeshed/issues/4174#issuecomment-639099914
https://github.com/JelleZijlstra
JelleZijlstrahttps://github.com/JelleZijlstra
on Jun 4, 2020https://github.com/python/typeshed/issues/4174#issuecomment-639151014
@hauntsaninjahttps://github.com/hauntsaninja
https://github.com/srittau
srittauhttps://github.com/srittau
on Jun 8, 2020https://github.com/python/typeshed/issues/4174#issuecomment-640503688
https://github.com/CraftSpider
CraftSpiderhttps://github.com/CraftSpider
on Jun 12, 2020https://github.com/python/typeshed/issues/4174#issuecomment-643473081
srittauhttps://github.com/srittau
on Jun 14, 2020https://github.com/python/typeshed/issues/4174#event-3441743057
Protocol naming guidelineshttps://github.com/srittau/typeshed/commit/6ba9bac5b923e249e6ca8c037126f4a5f467af27
https://docs.github.com/articles/closing-issues-via-commit-messages
6ba9bachttps://github.com/srittau/typeshed/commit/6ba9bac5b923e249e6ca8c037126f4a5f467af27
srittauhttps://github.com/srittau
completedhttps://github.com/python/typeshed/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
#4229https://github.com/python/typeshed/pull/4229
on Jun 14, 2020https://github.com/python/typeshed/issues/4174#event-3441763032
srittauhttps://github.com/srittau
on Jun 14, 2020https://github.com/python/typeshed/issues/4174#event-3441763054
Protocol naming guidelines (#4229)https://github.com/python/typeshed/commit/ef74bee249bd288ce5ed0b5e7024092a1bef1339
#4229https://github.com/python/typeshed/pull/4229
https://docs.github.com/articles/closing-issues-via-commit-messages
ef74beehttps://github.com/python/typeshed/commit/ef74bee249bd288ce5ed0b5e7024092a1bef1339
vishalkuohttps://github.com/vishalkuo
on Jun 26, 2020https://github.com/python/typeshed/issues/4174#event-3487539284
Protocol naming guidelines (python#4229)https://github.com/vishalkuo/typeshed/commit/14defcb726ac0d54e97d9666ea1cb7824446720b
python#4229https://github.com/python/typeshed/pull/4229
https://docs.github.com/articles/closing-issues-via-commit-messages
14defcbhttps://github.com/vishalkuo/typeshed/commit/14defcb726ac0d54e97d9666ea1cb7824446720b
Sign up for freehttps://github.com/signup?return_to=https://github.com/python/typeshed/issues/4174
Sign in to commenthttps://github.com/login?return_to=https://github.com/python/typeshed/issues/4174
project: policyOrganization of the typeshed projecthttps://github.com/python/typeshed/issues?q=state%3Aopen%20label%3A%22project%3A%20policy%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.