Title: Mypy doesn't seem to use types from @overload-ed __sub__ · Issue #11613 · python/mypy · GitHub
Open Graph Title: Mypy doesn't seem to use types from @overload-ed __sub__ · Issue #11613 · python/mypy
X Title: Mypy doesn't seem to use types from @overload-ed __sub__ · Issue #11613 · python/mypy
Description: Bug Report The __sub__ method on the Arrow class from the arrow package has several @overloads: @overload def __sub__(self, other: Union[timedelta, relativedelta]) -> "Arrow": pass # pragma: no cover @overload def __sub__(self, other: Un...
Open Graph Description: Bug Report The __sub__ method on the Arrow class from the arrow package has several @overloads: @overload def __sub__(self, other: Union[timedelta, relativedelta]) -> "Arrow": pass # pragma: no cov...
X Description: Bug Report The __sub__ method on the Arrow class from the arrow package has several @overloads: @overload def __sub__(self, other: Union[timedelta, relativedelta]) -> "Arrow": pass # p...
Opengraph URL: https://github.com/python/mypy/issues/11613
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Mypy doesn't seem to use types from @overload-ed __sub__","articleBody":"**Bug Report**\r\n\r\nThe `__sub__` method on the `Arrow` class from the `arrow` package [has several `@overload`s](https://github.com/arrow-py/arrow/blob/d688de482c5379455dfad8163f56749e81b9e806/arrow/arrow.py#L1730):\r\n\r\n```python\r\n@overload\r\ndef __sub__(self, other: Union[timedelta, relativedelta]) -> \"Arrow\":\r\n pass # pragma: no cover\r\n\r\n@overload\r\ndef __sub__(self, other: Union[dt_datetime, \"Arrow\"]) -> timedelta:\r\n pass # pragma: no cover\r\n\r\ndef __sub__(self, other: Any) -> Union[timedelta, \"Arrow\"]:\r\n\r\n if isinstance(other, (timedelta, relativedelta)):\r\n return self.fromdatetime(self._datetime - other, self._datetime.tzinfo)\r\n\r\n elif isinstance(other, dt_datetime):\r\n return self._datetime - other\r\n\r\n elif isinstance(other, Arrow):\r\n return self._datetime - other._datetime\r\n\r\n return NotImplemented\r\n```\r\n\r\nIn particular, one `Arrow` object minus another `Arrow` object will always yield a `timedelta`. However, it seems mypy does not see this, and mistakes the type for `Arrow`.\r\n\r\n\r\n**To Reproduce**\r\n\r\nI discovered the issue when finding the time diff between two arrow timestamps:\r\n\r\n``` python\r\nimport arrow\r\n\r\na1 = arrow.get()\r\na2 = arrow.get()\r\n\r\ndiff = a2 - a1\r\nprint(diff.total_seconds())\r\n```\r\n\r\nWhich, when run with mypy yields:\r\n\r\n```\r\n$ mypy test.py\r\ntest.py:6: error: \"int\" not callable\r\nFound 1 error in 1 file (checked 1 source file)\r\n```\r\n\r\nSetting the type explicitly reviles that mypy thinks the type is `Arrow`, and not `timedelta`:\r\n\r\n``` python\r\nfrom datetime import timedelta\r\nimport arrow\r\n\r\na1 = arrow.get()\r\na2 = arrow.get()\r\n\r\ndiff: timedelta = a2 - a1\r\nprint(diff.total_seconds())\r\n```\r\n\r\nRunning mypy:\r\n\r\n```\r\n$ mypy test.py\r\ntest.py:7: error: Incompatible types in assignment (expression has type \"Arrow\", variable has type \"timedelta\")\r\nFound 1 error in 1 file (checked 1 source file)\r\n```\r\n\r\n\r\n**Expected Behavior**\r\n\r\nThe second `@overload` on `Arrow`'s `__sub__` method specifies that the diff of two `Arrow` objects is a `timedelta`. There should be no type error assigning that to a `timedelta` variable.\r\n\r\n\r\n**Actual Behavior**\r\n\r\nMypy mistakenly thinks the diff is `Arrow`, which creates a false positive.\r\n\r\n\r\n**Your Environment**\r\n\r\n\u003c!-- Include as many relevant details about the environment you experienced the bug in -->\r\n\r\n- Mypy version used: 0.910\r\n- Mypy command-line flags: None\r\n- Mypy configuration options from `mypy.ini` (and other config files): None\r\n- Python version used: 3.9.6\r\n- Operating system and version: Mac OS 11.6 (Big Sur)\r\n","author":{"url":"https://github.com/mathialo","@type":"Person","name":"mathialo"},"datePublished":"2021-11-25T12:41:05Z","url":"https://github.com/python/mypy/issues/11613"}
| 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:c86825d9-2d36-0fbc-7df0-d4b837a05797 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | BB26:1DD784:FDC94:153A67:6B001D8E |
| html-safe-nonce | 3db0ad2461f3eb58e19762ac25e9be63f0cf041bb0e3d3c6312b8b616b6a9047 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCQjI2OjFERDc4NDpGREM5NDoxNTNBNjc6NkIwMDFEOEUiLCJ2aXNpdG9yX2lkIjoiMTQ5OTU2ODM2ODQwMTc4NDIwNyIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | f6e658703a56f4afba8246f233ebba17cef3f3fc7126717c28d470fe89881378 |
| hovercard-subject-tag | issue:1063541518 |
| 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/11613/issue_layout |
| twitter:image | https://opengraph.githubassets.com/672da531135751cf9ac09bbfcf557d6ce03a94ff89eaad6512f7e82a89007dbb/python/mypy/issues/11613 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/672da531135751cf9ac09bbfcf557d6ce03a94ff89eaad6512f7e82a89007dbb/python/mypy/issues/11613 |
| og:image:alt | Bug Report The __sub__ method on the Arrow class from the arrow package has several @overloads: @overload def __sub__(self, other: Union[timedelta, relativedelta]) -> "Arrow": pass # pragma: no cov... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | mathialo |
| hostname | github.com |
| expected-hostname | github.com |
| None | 4eb4cba0d69f045374ac15de9666d22b0961e1d555cc3824f36b7734c00c78e0 |
| 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 | 44c658b24abf00491fb7ae5f56d42c9f38cbeab2 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width