Title: Incompatible types detected in assignment of `self` to target of type `Self`, when using `Self` only in method body · Issue #14708 · python/mypy · GitHub
Open Graph Title: Incompatible types detected in assignment of `self` to target of type `Self`, when using `Self` only in method body · Issue #14708 · python/mypy
X Title: Incompatible types detected in assignment of `self` to target of type `Self`, when using `Self` only in method body · Issue #14708 · python/mypy
Description: Bug Report When assigning self to a list element, where the list is of type list[Self], mypy will treat self to be incompatible with Self as long as Self does not appear in the method signature. To Reproduce Playground: https://mypy-play...
Open Graph Description: Bug Report When assigning self to a list element, where the list is of type list[Self], mypy will treat self to be incompatible with Self as long as Self does not appear in the method signature. To...
X Description: Bug Report When assigning self to a list element, where the list is of type list[Self], mypy will treat self to be incompatible with Self as long as Self does not appear in the method signature. To...
Opengraph URL: https://github.com/python/mypy/issues/14708
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Incompatible types detected in assignment of `self` to target of type `Self`, when using `Self` only in method body","articleBody":"**Bug Report**\r\n\r\nWhen assigning `self` to a list element, where the list is of type `list[Self]`, mypy will treat `self` to be incompatible with `Self` as long as `Self` does not appear in the method signature.\r\n\r\n**To Reproduce**\r\n\r\nPlayground: https://mypy-play.net/?mypy=latest&python=3.11&gist=124fa26ca946c7ae040c43d788a694cb\r\n\r\n```python\r\nfrom typing import Self\r\n\r\n\r\nclass A:\r\n def __init__(self) -> None:\r\n self.siblings: list[Self] = []\r\n\r\n def insert(self, index: int):\r\n self.siblings[index] = self # this fails\r\n\r\n def insert__no_return(self, index: int) -> None:\r\n self.siblings[index] = self # this fails\r\n\r\n def insert__return(self, index: int) -> list[Self]:\r\n self.siblings[index] = self # this does not fail\r\n return self.siblings\r\n\r\n def insert__annotate_self(self: Self, index: int):\r\n self.siblings[index] = self # this does not fail\r\n\r\n def local_variable(self) -> None:\r\n l: list[Self] = [self] # this fails\r\n l[0] = self # this fails\r\n\r\n def local_variable__return(self) -> list[Self]:\r\n l: list[Self] = [self] # this does not fail\r\n l[0] = self # this does not fail\r\n return l\r\n```\r\n\r\n**Expected Behavior**\r\n\r\n- No errors. \r\n- Assigning `self` to a target of type `Self` should obviously work (or am I missing something here?)\r\n- returning the list and specifying the function return type should not change the behavior \r\n- specifying the type of `self` to be `Self` should not change the behavior\r\n\r\n**Actual Behavior**\r\n\r\nMypy detects imcompatible assignments:\r\n```\r\nmain.py:15: error: Incompatible types in assignment (expression has type \"A\", target has type \"Self\") [assignment]\r\nmain.py:18: error: Incompatible types in assignment (expression has type \"A\", target has type \"Self\") [assignment]\r\nmain.py:28: error: List item 0 has incompatible type \"A\"; expected \"Self\" [list-item]\r\nmain.py:29: error: Incompatible types in assignment (expression has type \"A\", target has type \"Self\") [assignment]\r\nFound 4 errors in 1 file (checked 1 source file)\r\n```\r\n\r\n**Maybe it's actually undefined behavior?**\r\n\r\nDigging deeper, it looks like [PEP 673](https://peps.python.org/pep-0673/#use-in-method-signatures) lists examples of what are valid or invalid use cases of the `Self` type. It explicitly states that\r\n\r\n> \"Self used in the signature of a method is treated as if it were a TypeVar bound to the class\"\r\n\r\nThis definition would not cover my example above, as it does only fail if `Self` has been used in _only the body, but not the signature_. On the other hand, this case is listed neither as a positive or negative use case; it is not covered at all by PEP 673, but all examples show that the intention of PEP 673 was to _avoid_ having to explicitly state a signature of `self: Self`, as that would state the obvious.\r\n\r\nThus, considering PEP 673, it might be undefined behavior?\r\n\r\nOn the other hand, following [PEP 484](https://peps.python.org/pep-0484/#annotating-instance-and-class-methods):\r\n\r\n> the first argument of class and instance methods [...] is assumed to have the type of the containing class for instance methods [...]\r\n\r\nI guess that's the old definition and does not include how to apply `Self`. It would explain mypy behavior - at least to some end. If this were the explanation, then mypy should actually fail or at least warn about incorrect usage of `Self` in `__init__` and `local_variable`. With `Self` being treated as a special case if and only if it appears in method signatures, it does not make sense to use it at those places; at least I cannot think of a use case. I do believe that it is not intended to be used on its own. Thus, an explicit warning, or even an error, would be very helpful in this case.\r\n\r\nSo is this a bug in mypy or is it something that actually simply strictly follows PEP definition? In the second case, I would still consider my example code to be desirable behavior and would be happy to get some hints on how to make this behavior become part of python typing definitions :)\r\n\r\nOr if you would think that this would not be desirable, i'd be happy to learn about your rationale.\r\n\r\n**Your Environment**\r\n\r\n- Mypy version used: 1.0.0\r\n- Mypy command-line flags: none\r\n- Mypy configuration options from `mypy.ini` (and other config files): installed mypy in a fresh virtualenv, no manual configuration\r\n- Python version used: 3.11.2\r\n\r\n","author":{"url":"https://github.com/noresistence","@type":"Person","name":"noresistence"},"datePublished":"2023-02-15T14:40:29Z","url":"https://github.com/python/mypy/issues/14708"}
| 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:8d6d5ac6-f0d4-e463-720f-7f922559a3e5 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | C1A2:1B0A31:1929A8A:21E56F8:6AFFF7E8 |
| html-safe-nonce | e2fee5c15e28c14e718251ca35c072ba7023ea5863e71dcf533fbad45efae074 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJDMUEyOjFCMEEzMToxOTI5QThBOjIxRTU2Rjg6NkFGRkY3RTgiLCJ2aXNpdG9yX2lkIjoiNjE4OTQ1MjA4NzU4ODI4ODQ4OCIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 69fa6cf49fcfe5479132724b797d28d517a856532da5be656549f1752fc11955 |
| hovercard-subject-tag | issue:1585977641 |
| 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/14708/issue_layout |
| twitter:image | https://opengraph.githubassets.com/ed5b0bc732cdd320d5dc7f647afddfd3db35d097c78b1dffeb61447154075198/python/mypy/issues/14708 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/ed5b0bc732cdd320d5dc7f647afddfd3db35d097c78b1dffeb61447154075198/python/mypy/issues/14708 |
| og:image:alt | Bug Report When assigning self to a list element, where the list is of type list[Self], mypy will treat self to be incompatible with Self as long as Self does not appear in the method signature. To... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | noresistence |
| 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