Title: Various stubgen regressions in mypy 1.7.0 · Issue #16486 · python/mypy · GitHub
Open Graph Title: Various stubgen regressions in mypy 1.7.0 · Issue #16486 · python/mypy
X Title: Various stubgen regressions in mypy 1.7.0 · Issue #16486 · python/mypy
Description: Bug Report Trying to update mypy from 1.6.1 to 1.7.0 has revealed a few regressions in the stub generator output related to pybind11 modules. To Reproduce Consider this pybind11 module: #include
Open Graph Description: Bug Report Trying to update mypy from 1.6.1 to 1.7.0 has revealed a few regressions in the stub generator output related to pybind11 modules. To Reproduce Consider this pybind11 module: #include X Description: Bug Report Trying to update mypy from 1.6.1 to 1.7.0 has revealed a few regressions in the stub generator output related to pybind11 modules. To Reproduce Consider this pybind11 module: #include &l...
Opengraph URL: https://github.com/python/mypy/issues/16486
X: @github
Domain: github.com
Links:
Viewport: width=device-width
Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Various stubgen regressions in mypy 1.7.0","articleBody":"**Bug Report**\r\n\r\nTrying to update mypy from 1.6.1 to 1.7.0 has revealed a few regressions in the stub generator output related to pybind11 modules.\r\n\r\n**To Reproduce**\r\n\r\nConsider this pybind11 module:\r\n\r\n```c++\r\n#include \u003cfilesystem>\r\n#include \u003coptional>\r\n#include \u003cutility>\r\n#include \u003cvector>\r\n\r\n#include \u003cpybind11/pybind11.h>\r\n#include \u003cpybind11/stl.h>\r\n\r\nnamespace py = pybind11;\r\n\r\nstd::vector\u003cfloat> funcReturningVector()\r\n{\r\n return std::vector\u003cfloat>{1.0, 2.0, 3.0, 4.0};\r\n}\r\n\r\nstd::pair\u003cint, float> funcReturningPair()\r\n{\r\n return std::pair{42, 1.0};\r\n}\r\n\r\nstd::optional\u003cint> funcReturningOptional()\r\n{\r\n return std::nullopt;\r\n}\r\n\r\nstd::filesystem::path funcIncompleteSignature()\r\n{\r\n // This example does not include \u003cpybind11/stl/filesystem.h> on purpose\r\n // to demonstrate the signature of an incomplete binding.\r\n return std::filesystem::path{\"foobar\"};\r\n}\r\n\r\nstruct MyStruct\r\n{\r\n int a;\r\n int b;\r\n int c;\r\n};\r\n\r\nPYBIND11_MODULE(my_native_module, m)\r\n{\r\n m.def(\"func_returning_vector\", &funcReturningVector);\r\n m.def(\"func_returning_pair\", &funcReturningPair);\r\n m.def(\"func_returning_optional\", &funcReturningOptional);\r\n\r\n m.def(\"func_incomplete_signature\", &funcIncompleteSignature);\r\n\r\n py::class_\u003cMyStruct>(m, \"MyStruct\")\r\n .def_readwrite(\"a\", &MyStruct::a)\r\n .def_readwrite(\"b\", &MyStruct::b, \"some docstring\")\r\n .def_property_readonly(\r\n \"c\",\r\n [](const MyStruct& x) {\r\n return x.c;\r\n },\r\n \"some docstring\");\r\n}\r\n```\r\n\r\nTo reproduce, store the above snippet as `my_native_module.cpp` and then:\r\n\r\n```sh\r\n# Install latest pybind11:\r\npip install pybind11==2.11.1\r\n\r\n# Compile pybind11 module:\r\nc++ -O3 -Wall -shared -std=c++17 -fPIC $(python3 -m pybind11 --includes) my_native_module.cpp -o my_native_module.so\r\n\r\n# Run the stub generator on it:\r\nstubgen -p my_native_module\r\n```\r\n\r\n**Expected Behavior**\r\n\r\nmypy 1.6.1 outputs the following, which is pretty reasonable:\r\n\r\n```py\r\nfrom typing import Any, List, Optional, Tuple\r\n\r\nclass MyStruct:\r\n a: int\r\n b: int\r\n def __init__(self, *args, **kwargs) -> None: ...\r\n @property\r\n def c(self) -> int: ...\r\n\r\ndef func_incomplete_signature(*args, **kwargs) -> Any: ...\r\ndef func_returning_optional() -> Optional[int]: ...\r\ndef func_returning_pair() -> Tuple[int,float]: ...\r\ndef func_returning_vector() -> List[float]: ...\r\n```\r\n\r\n**Actual Behavior**\r\n\r\nmypy 1.7.0 outputs the following:\r\n\r\n```py\r\nfrom _typeshed import Incomplete\r\n\r\nclass MyStruct:\r\n a: int\r\n b: Incomplete\r\n def __init__(self, *args, **kwargs) -> None: ...\r\n @property\r\n def c(self): ...\r\n\r\ndef func_incomplete_signature(*args, **kwargs): ...\r\ndef func_returning_optional() -> Optional[int]: ...\r\ndef func_returning_pair() -> Tuple[int, float]: ...\r\ndef func_returning_vector() -> List[float]: ...\r\n```\r\n\r\nThe regressions are:\r\n\r\n- The most obvious thing is that the imports for `List`, `Tuple`, and `Optional` are missing. This makes the resulting `.pyi` invalid, because it uses symbols that have not been imported. The stub output does not type check. This is not limited to these three types, but applies to other types like `Iterable`, `Iterator`, `Dict`, `Set`, `Union`, etc.\r\n- The type annotation of field `b` has regressed from `int` to `Incomplete`, apparently due to the explicit docstring.\r\n- The type annotation of field `c` has regressed from `int` to not annotated at all, probably also because of the explicit docstring.\r\n- The signature of the `func_incomplete_signature` has also slightly worsened: Before, it was at least annotated as `-> Any` but now it misses any return type annotation at all. This is problematic when users want to validate their generated stubs for completeness, i.e., run `mypy --disallow-untyped-defs` on the output. Of course semantically it is the same, but still it would be nicer to always produce some return type (arguably a broken signature may be rather annotated as `-> object` instead of `-> Incomplete` to avoid running into bugs from incomplete stub output).\r\n\r\n\r\n**Your Environment**\r\n\r\n- Mypy version used: 1.7.0\r\n- Mypy command-line flags: irrelevant for stubgen\r\n- Mypy configuration options from `mypy.ini` (and other config files): irrelevant for stubgen\r\n- Python version used: 3.10\r\n\r\n","author":{"url":"https://github.com/bluenote10","@type":"Person","name":"bluenote10"},"datePublished":"2023-11-14T13:49:56Z","url":"https://github.com/python/mypy/issues/16486"}
react-profiling 0 react-import-map react,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-controller voltron_issues_fragments route-action issue_layout fetch-nonce v2:5c1956dd-7bd9-c1a2-d0e9-ab5e4b77181a current-catalog-service-hash 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 request-id CCE2:1DA29F:10A40FD:15C0868:6AFFFA16 html-safe-nonce 75440d4dde3435d295b18dfe71df4c7e225ef125cf8da97fed87ba8496dfe8c9 visitor-payload eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJDQ0UyOjFEQTI5RjoxMEE0MEZEOjE1QzA4Njg6NkFGRkZBMTYiLCJ2aXNpdG9yX2lkIjoiODYyNDkxOTEzNzIxMjE1NTEwIiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= visitor-hmac 568895d20bc82d4b40c5aa43d4f3a8fb1eced5affbf47f009d98441b5735cfc6 hovercard-subject-tag issue:1992784694 github-keyboard-shortcuts repository,issues,copilot google-site-verification Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I octolytics-url https://collector.github.com/github/collect analytics-location / fb:app_id 1401488693436528 apple-itunes-app app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python/mypy/16486/issue_layout twitter:image https://opengraph.githubassets.com/dc5bf7314a64a730c9c6ecd7c8676976818c196fc9fc728bcfe2b27abc16cc2e/python/mypy/issues/16486 twitter:card summary_large_image og:image https://opengraph.githubassets.com/dc5bf7314a64a730c9c6ecd7c8676976818c196fc9fc728bcfe2b27abc16cc2e/python/mypy/issues/16486 og:image:alt Bug Report Trying to update mypy from 1.6.1 to 1.7.0 has revealed a few regressions in the stub generator output related to pybind11 modules. To Reproduce Consider this pybind11 module: #include og:image:width 1200 og:image:height 600 og:site_name GitHub og:type object og:author:username bluenote10 hostname github.com expected-hostname github.com None 0a0d8686a27478df474dd7415776a7a080cde8838b3cd92ea7601187572e5729 turbo-cache-control no-preview go-import github.com/python/mypy git https://github.com/python/mypy.git octolytics-dimension-user_id 1525981 octolytics-dimension-user_login python octolytics-dimension-repository_id 7053637 octolytics-dimension-repository_nwo python/mypy octolytics-dimension-repository_public true octolytics-dimension-repository_is_fork false octolytics-dimension-repository_network_root_id 7053637 octolytics-dimension-repository_network_root_nwo python/mypy turbo-body-classes logged-out env-production page-responsive disable-turbo false browser-stats-url https://api.github.com/_private/browser/stats browser-errors-url https://api.github.com/_private/browser/errors release 16a11879678aaf97e2a42c33ee70830aa084fa37 ui-target full theme-color #1e2327 color-scheme light dark react-app-name issues
URLs of crawlers that visited me.