Title: Idea: short-circuit analysis with `if
Open Graph Title: Idea: short-circuit analysis with `if
X Title: Idea: short-circuit analysis with `if
Description: Hey all, I'm adding OS-specific typechecking to a large Python app, and we have a fair number of files and functions that mix OS versions. Currently, mypy only does limited analysis with platform/version/constants to figure out which lin...
Open Graph Description: Hey all, I'm adding OS-specific typechecking to a large Python app, and we have a fair number of files and functions that mix OS versions. Currently, mypy only does limited analysis with platform/v...
X Description: Hey all, I'm adding OS-specific typechecking to a large Python app, and we have a fair number of files and functions that mix OS versions. Currently, mypy only does limited analysis with platfo...
Opengraph URL: https://github.com/python/mypy/issues/5964
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Idea: short-circuit analysis with `if \u003cplatform-check>: return`","articleBody":"Hey all,\r\n\r\nI'm adding OS-specific typechecking to a large Python app, and we have a fair number of files and functions that mix OS versions. Currently, mypy only does limited analysis with platform/version/constants to figure out which lines it shouldn't check. With that limited analysis, it's possible to add OS-specific typechecking to the app, but it'll make the code a bit messier.\r\n\r\nI'd like to get your feedback on two ideas that would make adding OS-specific typechecking easier.\r\n\r\n1. For `if` statements where the expression is a mypy-constant, short-circuit if there's a `return` statement one-level deep in the body of the `if`. (Currently, the inner bodies of the if are conditionally checked, and `return` doesn't short-circuit checking.)\r\n\r\nE.g.\r\n```python\r\n# flags: --always-false=IS_WINDOWS\r\nif IS_WINDOWS:\r\n import win_specific_import\r\n\r\ndef some_fun_broken() -> int:\r\n if not IS_WINDOWS:\r\n return 1 # checked\r\n # The rest of this function is analyzed even though we returned above. \r\n\r\n # Blows up since `win_specific_import` isn't defined\r\n return win_specific_import.something()\r\n\r\ndef some_fun_fixed() -> int:\r\n if not IS_WINDOWS:\r\n return 1 # checked\r\n else:\r\n # Not analyzed because this is in the `else` part of the `if` statement\r\n return win_specific_import.something() # Works\r\n```\r\n\r\nWe use the `if not IS_WINDOWS: return` pattern a fair amount in our codebase, and it would be nice if mypy supported that.\r\n\r\nI'm not sure how we'd implement that in mypy, though. Maybe we can scan for a `return` one-level deep in `if` statement bodies which have a mypy-constant expression and mark the rest of the function as unreachable.\r\n\r\n2. Make mypy-constant asserts also ignore function bodies. This would be an extension of #5308. E.g.\r\n\r\n```python\r\n# flags: --always-false=IS_WINDOWS\r\n\r\nif IS_WINDOWS:\r\n import win_specific_import\r\n\r\ndef invalid_win_specific_function() -> bool:\r\n assert IS_WINDOWS\r\n return win_specific_import.some_func() # This blows up\r\n\r\nif IS_WINDOWS:\r\n def valid_win_specific_function() -> bool:\r\n return win_specific_import.some_func()\r\n```\r\n\r\nIt would be convenient if we ignored the rest of the function body if the first statement in it is a mypy-constant assert. I don't think we'd want to look for asserts elsewhere in the function block, though, even though that would make it a magical special-case.\r\n\r\nAny thoughts on the above ideas?","author":{"url":"https://github.com/samertm","@type":"Person","name":"samertm"},"datePublished":"2018-11-28T03:30:27Z","url":"https://github.com/python/mypy/issues/5964"}
| 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:da9f2850-fc2b-1f43-c03a-dfe92111477a |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | D67E:1F7A:B21B87:F1FD6C:6AFFFAD2 |
| html-safe-nonce | 0e4d6f28c89b1dfbd5e721769be5c8775948d4b92124ab6ed247b08e44d36a09 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJENjdFOjFGN0E6QjIxQjg3OkYxRkQ2Qzo2QUZGRkFEMiIsInZpc2l0b3JfaWQiOiIyMTQ5MDIzNTQwNTc2MjQyNzQiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 6defba725458333f3f06482893229675fcfad7582739c7390115f4d56bea02d6 |
| hovercard-subject-tag | issue:385085868 |
| 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/5964/issue_layout |
| twitter:image | https://opengraph.githubassets.com/e9551ee756fd00adf052c38b031b6699409ee43ef634fa603abb07ed47c3e3af/python/mypy/issues/5964 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/e9551ee756fd00adf052c38b031b6699409ee43ef634fa603abb07ed47c3e3af/python/mypy/issues/5964 |
| og:image:alt | Hey all, I'm adding OS-specific typechecking to a large Python app, and we have a fair number of files and functions that mix OS versions. Currently, mypy only does limited analysis with platform/v... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | samertm |
| 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 |
Links:
Viewport: width=device-width