Skip to content

Allow union-with-callable attributes to be overridden by methods#18018

Merged
hauntsaninja merged 7 commits intopython:masterfrom
brianschubert:gh-12569-method-override-union
Oct 29, 2024
Merged

Allow union-with-callable attributes to be overridden by methods#18018
hauntsaninja merged 7 commits intopython:masterfrom
brianschubert:gh-12569-method-override-union

Conversation

@brianschubert
Copy link
Collaborator

@brianschubert brianschubert commented Oct 23, 2024

Fixes #12569

Before

from typing import Callable

class Parent:
    f1: Callable[[str], str]
    f2: Callable[[str], str] | str

class Child(Parent):
   def f1(self, x: str) -> str: return x  # ok
   def f2(self, x: str) -> str: return x  # Signature of "f2" incompatible with supertype "Parent"

After

from typing import Callable

class Parent:
    f1: Callable[[str], str]
    f2: Callable[[str], str] | str

class Child(Parent):
   def f1(self, x: str) -> str: return x  # ok
   def f2(self, x: str) -> str: return x  # ok

@github-actions

This comment has been minimized.

Sign in to view
JelleZijlstra
JelleZijlstra reviewed Oct 25, 2024
View reviewed changes
@JelleZijlstra JelleZijlstra mentioned this pull request Oct 25, 2024
Closed
@github-actions

This comment has been minimized.

Sign in to view
hauntsaninja
hauntsaninja reviewed Oct 25, 2024
View reviewed changes
Copy link
Collaborator

@hauntsaninja hauntsaninja left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Could you add a test case with this error code enabled: https://github.com/python/mypy/pull/16399/files

@brianschubert brianschubert force-pushed the gh-12569-method-override-union branch from 93f6bf7 to a9c5dac Compare October 29, 2024 00:04
@github-actions
Copy link
Contributor

github-actions bot commented Oct 29, 2024

Diff from mypy_primer, showing the effect of this PR on open source code:

packaging (https://github.com/pypa/packaging)
+ src/packaging/specifiers.py:248: error: Unused "type: ignore" comment  [unused-ignore]

steam.py (https://github.com/Gobot1234/steam.py)
- steam/models.py:239: error: Signature of "url" incompatible with supertype "_IOMixin"  [override]
- steam/models.py:239: note:      Superclass:
- steam/models.py:239: note:          str | _ReadOnlyProto[str]
- steam/models.py:239: note:      Subclass:
- steam/models.py:239: note:          str
- steam/reaction.py:236: error: Signature of "url" incompatible with supertype "_IOMixin"  [override]
- steam/reaction.py:236: note:      Superclass:
- steam/reaction.py:236: note:          str | _ReadOnlyProto[str]
- steam/reaction.py:236: note:      Subclass:
- steam/reaction.py:236: note:          str
- steam/reaction.py:273: error: Signature of "url" incompatible with supertype "_IOMixin"  [override]
- steam/reaction.py:273: note:      Superclass:
- steam/reaction.py:273: note:          str | _ReadOnlyProto[str]
- steam/reaction.py:273: note:      Subclass:
- steam/reaction.py:273: note:          str
- steam/reaction.py:312: error: Signature of "url" incompatible with supertype "_IOMixin"  [override]
- steam/reaction.py:312: note:      Superclass:
- steam/reaction.py:312: note:          str | _ReadOnlyProto[str]
- steam/reaction.py:312: note:      Subclass:
- steam/reaction.py:312: note:          str

hauntsaninja
hauntsaninja approved these changes Oct 29, 2024
View reviewed changes
Copy link
Collaborator

@hauntsaninja hauntsaninja left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

I kind of want to try ignore_pos_arg_names=False. This is something we probably want to eventually do anyway and should be fairly harmless in this case. But it's likely wiser to be consistent.

@hauntsaninja hauntsaninja merged commit c7c4288 into python:master Oct 29, 2024
@hauntsaninja
Copy link
Collaborator

hauntsaninja commented Nov 3, 2024

I was thinking about this PR some more and I think it introduces some unsoundness. We should have a Liskov error in the following:

import typing

class X:
    @property
    def x(self) -> typing.Optional[bool]: ...

    @x.setter
    def x(self, value: typing.Optional[bool]) -> None: ...

class Y(X):
    @property
    def x(self) -> bool: ...

    @x.setter
    def x(self, value: bool) -> None: ...

Input to setter should be wider, output of getter should be narrower.

@brianschubert
Copy link
Collaborator Author

brianschubert commented Nov 3, 2024 •
edited
Loading

Hmm, I think that setup is currently caught by mutable-override, is it not? Is the behavior after this PR different from what mypy does for this setup?

class X:
    x: bool | None

class Y(X):
    x: bool

@hauntsaninja
Copy link
Collaborator

hauntsaninja commented Nov 3, 2024

Oh looks like I must have messed up my test. It does error with mutable-override, sorry for the noise!

@hauntsaninja
Copy link
Collaborator

hauntsaninja commented Nov 3, 2024

I think what happened is I messed up the branches I tested. I think I probably did this, which mypy doesn't error on:

class AA:
    @property
    def a(self) -> int: ...
    @a.setter
    def a(self, value: int | str) -> None: ...

class BB(AA):
    @property
    def a(self) -> int: ...
    @a.setter
    def a(self, value: int) -> None: ...

This would be unsound, except that mypy doesn't support this at all and will error if you attempt to set a to str. This is the (very popular) issue for that: #3004

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@JelleZijlstra JelleZijlstra JelleZijlstra left review comments

@hauntsaninja hauntsaninja hauntsaninja approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

mypy incorrectly marks a @staticmethod definition of an attribute A to be incompatible with A's signature in a parent class.

3 participants

@brianschubert @hauntsaninja @JelleZijlstra