René's URL Explorer Experiment


Title: Ignore generic type signature in pybind11 functions and methods with overloads · Issue #9070 · python/mypy · GitHub

Open Graph Title: Ignore generic type signature in pybind11 functions and methods with overloads · Issue #9070 · python/mypy

X Title: Ignore generic type signature in pybind11 functions and methods with overloads · Issue #9070 · python/mypy

Description: I don't know if this is the correct place to address this issue, but I know that there's the expertise here to be able to discuss the correct approach to the problem. I've written this as a feature request, but there may be better approa...

Open Graph Description: I don't know if this is the correct place to address this issue, but I know that there's the expertise here to be able to discuss the correct approach to the problem. I've written this as a feature...

X Description: I don't know if this is the correct place to address this issue, but I know that there's the expertise here to be able to discuss the correct approach to the problem. I've written this ...

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

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Ignore generic type signature in pybind11 functions and methods with overloads","articleBody":"I don't know if this is the correct place to address this issue, but I know that there's the expertise here to be able to discuss the correct approach to the problem. I've written this as a feature request, but there may be better approaches to the problem.\r\n\r\n## Use Case\r\nI have a C++ module that's exposed to Python with pybind11. In this module I have a class with a method that has multiple types. To use an example from the pybind11 documentation:\r\n\r\n```cpp\r\npy::class_\u003cPet>(m, \"Pet\")\r\n   .def(py::init\u003cconst std::string &, int>())\r\n   .def(\"set\", (void (Pet::*)(int)) &Pet::set, \"Set the pet's age\")\r\n   .def(\"set\", (void (Pet::*)(const std::string &)) &Pet::set, \"Set the pet's name\");\r\n```\r\n\r\nThis produces docstrings that look like the following:\r\n\r\n```python\r\n>>> help(example.Pet)\r\n\r\nclass Pet(__builtin__.object)\r\n |  Methods defined here:\r\n |\r\n |  __init__(...)\r\n |      __init__(self: Pet, arg0: str, arg1: int) -> None\r\n |\r\n |  set(...)\r\n |      set(*args, **kwargs) -> Any\r\n |      Overloaded function.\r\n |\r\n |      1. set(self: Pet, arg0: int) -> None\r\n |\r\n |      Set the pet's age\r\n |\r\n |      2. set(self: Pet, arg0: str) -> None\r\n |\r\n |      Set the pet's name\r\n```\r\n\r\n## Current Behaviour\r\nWhen running stubgen against this module, the generated type stubs look like the following:\r\n\r\n```python\r\nfrom typing import overload\r\n\r\nclass Pet:\r\n    def __init__(self: Pet, arg0: str, arg1: int) -> None: ...\r\n    @overload\r\n    def set(self: Pet, arg0: int) -> None: ...\r\n    @overload\r\n    def set(self: Pet, arg0: str) -> None: ...\r\n    @overload\r\n    def set(*args, **kwargs) -> Any: ...\r\n```\r\n\r\nThe inclusion of the last overload essentially makes the type definition of the method useless because it'll accept anything.\r\nThe reason that this feels to me like an issue for stubgen to address is because I think that pybind11 is doing the right thing. The inclusion of `set(*args, **kwargs) -> Any` makes sense because tools like Sphinx need to be given a valid type signature and those tools expect that signature on the first line of the docstring.\r\n\r\n## Expected Behaviour\r\nWhen running stubgen against this module, the generated type stubs should look like the following:\r\n\r\n```python\r\nfrom typing import overload\r\n\r\nclass Pet:\r\n    def __init__(self: Pet, arg0: str, arg1: int) -> None: ...\r\n    @overload\r\n    def set(self: Pet, arg0: int) -> None: ...\r\n    @overload\r\n    def set(self: Pet, arg0: str) -> None: ...\r\n```\r\n\r\nNote that the `set(*args, **kwargs) -> Any` type signature has been ignored.\r\n\r\n## Implementation\r\nIf we decide that getting stubgen to ignore this specific type signature is the right thing to do, how should we do it? Ignoring `*args, *kwargs` here is not correct because having `*args` and `**kwargs` could be part of a valid signature: https://github.com/python/mypy/blob/007b7af9f96df9d23744d93fdf54e83bcdc01630/mypy/stubdoc.py#L193-L202\r\nWe could look for the \"Overloaded signature.\" line and ignore the type signature in only that case. It feels brittle, but I don't know how else we can determine whether this situation exists.\r\n\r\nDo we need to worry about the case where someone might decide to write the following:\r\n\r\n```python\r\n\"\"\"func(*args, **kwargs) -> Any\r\nDo a thing.\r\n\r\nfunc() -> None\r\nDo something else.\r\n```\r\n\r\n## Versions\r\n\r\n```\r\nmypy 0.780\r\nPython 3.7.7\r\n```","author":{"url":"https://github.com/AWhetter","@type":"Person","name":"AWhetter"},"datePublished":"2020-06-29T17:59:38Z","url":"https://github.com/python/mypy/issues/9070"}

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:7b725aee-eea9-ee5e-b38a-b83bd037e783
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idB2E8:5537E:1BBB7DD:24AECFE:6B002ABC
html-safe-noncef46492c4592780fafa04f2de71167158000dc8abbb2b3e234f800ae090a5ae4b
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCMkU4OjU1MzdFOjFCQkI3REQ6MjRBRUNGRTo2QjAwMkFCQyIsInZpc2l0b3JfaWQiOiIyNTI5NDg1MTA2MzIyNjE0OTcyIiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0=
visitor-hmacaff451e78ea82fc2846bc4ebe34e93f2a4d3be9142d18ee9183dcaa706ad4453
hovercard-subject-tagissue:647562793
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/9070/issue_layout
twitter:imagehttps://opengraph.githubassets.com/8bd0bf5132fc8f0a7c72e12512971b2fe7a273eae713c5ab205fe43770732dd4/python/mypy/issues/9070
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/8bd0bf5132fc8f0a7c72e12512971b2fe7a273eae713c5ab205fe43770732dd4/python/mypy/issues/9070
og:image:altI don't know if this is the correct place to address this issue, but I know that there's the expertise here to be able to discuss the correct approach to the problem. I've written this as a feature...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernameAWhetter
hostnamegithub.com
expected-hostnamegithub.com
None7d0829bbde9e48b2486cb5dd6d147896eb01d32134627091f818958a935ef3f0
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
releasef3f3a43ca095cdea3abbb394112e971f9fdb94fa
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/python/mypy/issues/9070#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython%2Fmypy%2Fissues%2F9070
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%2F9070
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/9070
Reloadhttps://github.com/python/mypy/issues/9070
Reloadhttps://github.com/python/mypy/issues/9070
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/9070
New issuehttps://github.com/login?return_to=https://github.com/python/mypy/issues/9070
#9903https://github.com/python/mypy/pull/9903
Ignore generic type signature in pybind11 functions and methods with overloadshttps://github.com/python/mypy/issues/9070#top
#9903https://github.com/python/mypy/pull/9903
https://github.com/AWhetter
AWhetterhttps://github.com/AWhetter
on Jun 29, 2020https://github.com/python/mypy/issues/9070#issue-647562793
mypy/mypy/stubdoc.pyhttps://github.com/python/mypy/blob/007b7af9f96df9d23744d93fdf54e83bcdc01630/mypy/stubdoc.py#L193-L202
007b7afhttps://github.com/python/mypy/commit/007b7af9f96df9d23744d93fdf54e83bcdc01630
https://github.com/JukkaL
JukkaLhttps://github.com/JukkaL
on Jul 3, 2020https://github.com/python/mypy/issues/9070#issuecomment-653608829
https://github.com/AWhetter
AWhetterhttps://github.com/AWhetter
on Jul 3, 2020https://github.com/python/mypy/issues/9070#issuecomment-653619369
https://github.com/YannickJadoul
YannickJadoulhttps://github.com/YannickJadoul
on Jul 12, 2020https://github.com/python/mypy/issues/9070#issuecomment-657265742
https://github.com/AWhetter
AWhetterhttps://github.com/AWhetter
on Jul 12, 2020https://github.com/python/mypy/issues/9070#issuecomment-657271506
@JukkaLhttps://github.com/JukkaL
https://github.com/AWhetter
AWhetterhttps://github.com/AWhetter
on Oct 24, 2020https://github.com/python/mypy/issues/9070#issuecomment-715667195
https://github.com/python/cpython/blob/c0f22fb8b3006936757cebb959cee94e285bc503/Objects/rangeobject.c#L156https://github.com/python/cpython/blob/c0f22fb8b3006936757cebb959cee94e285bc503/Objects/rangeobject.c#L156
sphinx-doc/sphinx#7748https://github.com/sphinx-doc/sphinx/pull/7748
@YannickJadoulhttps://github.com/YannickJadoul
https://github.com/YannickJadoul
YannickJadoulhttps://github.com/YannickJadoul
on Oct 24, 2020https://github.com/python/mypy/issues/9070#issuecomment-715926211
@AWhetterhttps://github.com/AWhetter
JelleZijlstrahttps://github.com/JelleZijlstra
completedhttps://github.com/python/mypy/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
#9903https://github.com/python/mypy/pull/9903
on Feb 11, 2021https://github.com/python/mypy/issues/9070#event-4320249196
Sign up for freehttps://github.com/signup?return_to=https://github.com/python/mypy/issues/9070
Sign in to commenthttps://github.com/login?return_to=https://github.com/python/mypy/issues/9070
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.